| { |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| } |
| } |
| } |
| }, |
| "basePath": "", |
| "baseUrl": "https://apigee.googleapis.com/", |
| "batchPath": "batch", |
| "canonicalName": "Apigee", |
| "description": "Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Get started using the APIs. *Note:* This product is available as a free trial for a time period of 60 days.", |
| "discoveryVersion": "v1", |
| "documentationLink": "https://cloud.google.com/apigee-api-management/", |
| "fullyEncodeReservedExpansion": true, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "id": "apigee:v1", |
| "kind": "discovery#restDescription", |
| "mtlsRootUrl": "https://apigee.mtls.googleapis.com/", |
| "name": "apigee", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "parameters": { |
| "$.xgafv": { |
| "description": "V1 error format.", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "alt": { |
| "default": "json", |
| "description": "Data format for response.", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "location": "query", |
| "type": "string" |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "key": { |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "quotaUser": { |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| "location": "query", |
| "type": "string" |
| }, |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "protocol": "rest", |
| "resources": { |
| "hybrid": { |
| "resources": { |
| "issuers": { |
| "methods": { |
| "list": { |
| "description": "Lists hybrid services and its trusted issuers service account ids. This api is authenticated and unauthorized(allow all the users) and used by runtime authn-authz service to query control plane's issuer service account ids.", |
| "flatPath": "v1/hybrid/issuers", |
| "httpMethod": "GET", |
| "id": "apigee.hybrid.issuers.list", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Must be of the form `hybrid/issuers`.", |
| "location": "path", |
| "pattern": "^hybrid/issuers$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListHybridIssuersResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "organizations": { |
| "methods": { |
| "create": { |
| "description": "Creates an Apigee organization. See [Create an organization](https://docs.apigee.com/hybrid/latest/precog-provision).", |
| "flatPath": "v1/organizations", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.create", |
| "parameterOrder": [], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: `projects/`", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/organizations", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Organization" |
| }, |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets the profile for an Apigee organization. See [Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations).", |
| "flatPath": "v1/organizations/{organizationsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Apigee organization name in the following format: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Organization" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getDeployedIngressConfig": { |
| "description": "Gets the deployed ingress configuration for an organization.", |
| "flatPath": "v1/organizations/{organizationsId}/deployedIngressConfig", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.getDeployedIngressConfig", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the deployed configuration for the organization in the following format: 'organizations/{org}/deployedIngressConfig'.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/deployedIngressConfig$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1IngressConfig" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getSyncAuthorization": { |
| "description": "Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Enable Synchronizer access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access). **Note**: Available to Apigee hybrid only.", |
| "flatPath": "v1/organizations/{organizationsId}:getSyncAuthorization", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.getSyncAuthorization", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}:getSyncAuthorization", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1GetSyncAuthorizationRequest" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1SyncAuthorization" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations).", |
| "flatPath": "v1/organizations", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Use the following structure in your request: `organizations`", |
| "location": "path", |
| "pattern": "^organizations$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListOrganizationsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "setSyncAuthorization": { |
| "description": "Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version. To get an ETag, call [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Enable Synchronizer access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access). **Note**: Available to Apigee hybrid only.", |
| "flatPath": "v1/organizations/{organizationsId}:setSyncAuthorization", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.setSyncAuthorization", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}:setSyncAuthorization", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1SyncAuthorization" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1SyncAuthorization" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.", |
| "flatPath": "v1/organizations/{organizationsId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Apigee organization name in the following format: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Organization" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Organization" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "analytics": { |
| "resources": { |
| "datastores": { |
| "methods": { |
| "create": { |
| "description": "Create a Datastore for an org", |
| "flatPath": "v1/organizations/{organizationsId}/analytics/datastores", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.analytics.datastores.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent organization name. Must be of the form `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/analytics/datastores", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Datastore" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Datastore" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Delete a Datastore from an org.", |
| "flatPath": "v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.analytics.datastores.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Resource name of the Datastore to be deleted. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Get a Datastore", |
| "flatPath": "v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.analytics.datastores.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Resource name of the Datastore to be get. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Datastore" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "List Datastores", |
| "flatPath": "v1/organizations/{organizationsId}/analytics/datastores", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.analytics.datastores.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent organization name. Must be of the form `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "targetType": { |
| "description": "Optional. TargetType is used to fetch all Datastores that match the type", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/analytics/datastores", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDatastoresResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "test": { |
| "description": "Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage", |
| "flatPath": "v1/organizations/{organizationsId}/analytics/datastores:test", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.analytics.datastores.test", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent organization name Must be of the form `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/analytics/datastores:test", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Datastore" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1TestDatastoreResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Update a Datastore", |
| "flatPath": "v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.analytics.datastores.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The resource name of datastore to be updated. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Datastore" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Datastore" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "apiproducts": { |
| "methods": { |
| "attributes": { |
| "description": "Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.apiproducts.attributes", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/attributes", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "create": { |
| "description": "Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on-the-fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer grained API products, defining different sets of API resources for each API product. *WARNING:* - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see {{what_api_product}}", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.apiproducts.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent organization name under which the API product will be created. Must be in the following form: organizations/organization_ID ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/apiproducts", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1ApiProduct" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProduct" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.apiproducts.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProduct" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apiproducts.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProduct" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The limit on the number of API products returned by the API is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apiproducts.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "attributename": { |
| "description": "The name of the attribute to search.", |
| "location": "query", |
| "type": "string" |
| }, |
| "attributevalue": { |
| "description": "The value of the attribute.", |
| "location": "query", |
| "type": "string" |
| }, |
| "count": { |
| "description": "Enter the number of API products you want returned in the API call. The limit is 1000.", |
| "format": "int64", |
| "location": "query", |
| "type": "string" |
| }, |
| "expand": { |
| "description": "Set to `true` to get expanded details about each API.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "**Required.** The parent organization name in the following form: organizations/organization_ID ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "startKey": { |
| "description": "Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the `count` query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using `startKey`). Product name is case sensitive.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/apiproducts", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListApiProductsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the Display Name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.apiproducts.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1ApiProduct" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProduct" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "attributes": { |
| "methods": { |
| "delete": { |
| "description": "Deletes an API product attribute.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.apiproducts.attributes.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Returns the value of an API product attribute.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apiproducts.attributes.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Returns a list of all API product attributes.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apiproducts.attributes.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent organization name. Must be in the following form: organizations/organization_ID/apiproducts/api_product_name ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/attributes", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateApiProductAttribute": { |
| "description": "Updates the value of an API product attribute. Limitations are: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", |
| "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.apiproducts.attributes.updateApiProductAttribute", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "apis": { |
| "methods": { |
| "create": { |
| "description": "Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.", |
| "flatPath": "v1/organizations/{organizationsId}/apis", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.apis.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "action": { |
| "description": "Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * `import` to import the API proxy configuration bundle. * `validate` to validate the API proxy configuration bundle without importing it.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the organization in the following format: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "validate": { |
| "description": "Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+parent}/apis", |
| "request": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProxyRevision" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.apis.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProxy" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets an API proxy including a list of existing revisions.", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apis.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProxy" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.", |
| "flatPath": "v1/organizations/{organizationsId}/apis", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apis.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "includeMetaData": { |
| "description": "Flag that specifies whether to include API proxy metadata in the response.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "includeRevisions": { |
| "description": "Flag that specifies whether to include a list of revisions in the response.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. Name of the organization in the following format: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/apis", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListApiProxiesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "deployments": { |
| "methods": { |
| "list": { |
| "description": "Lists all deployments of an API proxy.", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apis.deployments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeploymentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "keyvaluemaps": { |
| "methods": { |
| "create": { |
| "description": "Creates a key value map in an api proxy.", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.apis.keyvaluemaps.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The name of the environment in which to create the key value map. Must be of the form `organizations/{organization}/apis/{api}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/keyvaluemaps", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Delete a key value map in an api proxy.", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.apis.keyvaluemaps.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the key value map. Must be of the form `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "revisions": { |
| "methods": { |
| "delete": { |
| "description": "Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.apis.revisions.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProxyRevision" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, do the following: * Set the `format` query parameter to `bundle`. * Set the `Accept` header to `application/zip`. If you are using curl, specify `-o filename.zip` to save the output to a file; otherwise, it displays to `stdout`. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in [updateApiProxyRevision](updateApiProxyRevision).", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apis.revisions.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "format": { |
| "description": "Format used when downloading the API proxy configuration revision. Set to `bundle` to download the API proxy configuration revision as a zip file.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateApiProxyRevision": { |
| "description": "Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. You can update only API proxy revisions that have never been deployed. After deployment, an API proxy revision becomes immutable, even if it is undeployed. Set the `Content-Type` header to either `multipart/form-data` or `application/octet-stream`.", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.apis.revisions.updateApiProxyRevision", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "validate": { |
| "description": "Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ApiProxyRevision" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "deployments": { |
| "methods": { |
| "list": { |
| "description": "Lists all deployments of an API proxy revision.", |
| "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apis.revisions.deployments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeploymentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "apps": { |
| "methods": { |
| "get": { |
| "description": "Gets the app profile for the specified app ID.", |
| "flatPath": "v1/organizations/{organizationsId}/apps/{appsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apps.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. App ID in the following format: `organizations/{org}/apps/{app}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1App" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).", |
| "flatPath": "v1/organizations/{organizationsId}/apps", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.apps.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "apiProduct": { |
| "description": "API product.", |
| "location": "query", |
| "type": "string" |
| }, |
| "apptype": { |
| "description": "Optional. Filter by the type of the app. Valid values are `company` or `developer`. Defaults to `developer`.", |
| "location": "query", |
| "type": "string" |
| }, |
| "expand": { |
| "description": "Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "ids": { |
| "description": "Optional. Comma-separated list of app IDs on which to filter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "includeCred": { |
| "description": "Optional. Flag that specifies whether to include credentials in the response.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "keyStatus": { |
| "description": "Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Resource path of the parent in the following format: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "rows": { |
| "description": "Optional. Maximum number of app IDs to return. Defaults to 10000.", |
| "format": "int64", |
| "location": "query", |
| "type": "string" |
| }, |
| "startKey": { |
| "description": "Returns the list of apps starting from the specified app ID.", |
| "location": "query", |
| "type": "string" |
| }, |
| "status": { |
| "description": "Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/apps", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListAppsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "deployments": { |
| "methods": { |
| "list": { |
| "description": "Lists all deployments of API proxies or shared flows.", |
| "flatPath": "v1/organizations/{organizationsId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.deployments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the organization for which to return deployment information in the following format: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "sharedFlows": { |
| "description": "Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+parent}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeploymentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "developers": { |
| "methods": { |
| "attributes": { |
| "description": "Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.attributes", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Email address of the developer for which attributes are being updated in the following format: `organizations/{org}/developers/{developer_email}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/attributes", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "create": { |
| "description": "Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as `active`. To change the developer status, use the SetDeveloperStatus API.", |
| "flatPath": "v1/organizations/{organizationsId}/developers", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the Apigee organization in which the developer is created. Use the following structure in your request: `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/developers", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Developer" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Developer" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a developer. All apps and API keys associated with the developer are also removed. **Warning**: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to `inactive` using the SetDeveloperStatus API. **Note**: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.developers.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Developer" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Returns the developer details, including the developer's name, email address, apps, and other information. **Note**: The response includes only the first 100 developer apps.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "action": { |
| "description": "Status of the developer. Valid values are `active` or `inactive`.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Developer" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all developers in an organization by email address. By default, the response does not include company developers. Set the `includeCompany` query parameter to `true` to include company developers. **Note**: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the `startKey` and `count` query parameters.", |
| "flatPath": "v1/organizations/{organizationsId}/developers", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "count": { |
| "description": "Optional. Number of developers to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.", |
| "format": "int64", |
| "location": "query", |
| "type": "string" |
| }, |
| "expand": { |
| "description": "Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "ids": { |
| "description": "Optional. List of IDs to include, separated by commas.", |
| "location": "query", |
| "type": "string" |
| }, |
| "includeCompany": { |
| "description": "Flag that specifies whether to include company details in the response.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "startKey": { |
| "description": "**Note**: Must be used in conjunction with the `count` parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: ``` westley@example.com fezzik@example.com buttercup@example.com ``` and your `startKey` is `fezzik@example.com`, the list returned will be ``` fezzik@example.com buttercup@example.com ```", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/developers", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListOfDevelopersResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "setDeveloperStatus": { |
| "description": "Sets the status of a developer. Valid values are `active` or `inactive`. A developer is `active` by default. If you set a developer's status to `inactive`, the API keys assigned to the developer apps are no longer valid even though the API keys are set to `approved`. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won't work. If successful, the API call returns the following HTTP status code: `204 No Content`", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.setDeveloperStatus", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "action": { |
| "description": "Status of the developer. Valid values are `active` and `inactive`.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.developers.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Developer" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Developer" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "apps": { |
| "methods": { |
| "attributes": { |
| "description": "Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.apps.attributes", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/attributes", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "create": { |
| "description": "Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.apps.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/apps", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a developer app. **Note**: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.developers.apps.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "generateKeyPairOrUpdateDeveloperAppStatus": { |
| "description": "Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the `action` query parameter to `approved` or `revoked`, respectively, and the `Content-Type` header to `application/octet-stream`. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still `approved`. If successful, the API call returns the following HTTP status code: `204 No Content` To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (`approved` or `revoked`) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The `keyExpiresIn` property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to `-1`, the API key never expires. **Notes**: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "action": { |
| "description": "Action. Valid values are `approve` or `revoke`.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Returns the details for a developer app.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.apps.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "entity": { |
| "description": "**Note**: Must be used in conjunction with the `query` parameter. Set to `apiresources` to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "query": { |
| "description": "**Note**: Must be used in conjunction with the `entity` parameter. Set to `count` to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the `startKey` and `count` query parameters.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.apps.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "count": { |
| "description": "Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.", |
| "format": "int64", |
| "location": "query", |
| "type": "string" |
| }, |
| "expand": { |
| "description": "Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "shallowExpand": { |
| "description": "Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "startKey": { |
| "description": "**Note**: Must be used in conjunction with the `count` parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the `count` query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/apps", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeveloperAppsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.developers.apps.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "attributes": { |
| "methods": { |
| "delete": { |
| "description": "Deletes a developer app attribute.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.developers.apps.attributes.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Returns a developer app attribute.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.apps.attributes.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Returns a list of all developer app attributes.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.apps.attributes.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/attributes", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateDeveloperAppAttribute": { |
| "description": "Updates a developer app attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "keys": { |
| "methods": { |
| "create": { |
| "description": "Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee hybrid from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.apps.keys.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/keys", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. **Note**: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.developers.apps.keys.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Returns details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.apps.keys.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "replaceDeveloperAppKey": { |
| "description": "Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the `scopes` element under the `apiProducts` element in the attributes of the app.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.developers.apps.keys.replaceDeveloperAppKey", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateDeveloperAppKey": { |
| "description": "Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.apps.keys.updateDeveloperAppKey", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "action": { |
| "description": "Approve or revoke the consumer key by setting this value to `approve` or `revoke`, respectively.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "apiproducts": { |
| "methods": { |
| "delete": { |
| "description": "Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. **Note**: The consumer key is not removed, only its association with the API product.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.developers.apps.keys.apiproducts.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Name of the API product in the developer app key in the following format: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+/apiproducts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateDeveloperAppKeyApiProduct": { |
| "description": "Approve or revoke an app's consumer key. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee hybrid checks the status of the consumer key and if set to `revoked` will not allow access to the API.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "action": { |
| "description": "Approve or revoke the consumer key by setting this value to `approve` or `revoke`, respectively.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the API product in the developer app key in the following format: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+/apiproducts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "create": { |
| "methods": { |
| "create": { |
| "description": "Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee hybrid from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.apps.keys.create.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/keys/create", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeveloperAppKey" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "attributes": { |
| "methods": { |
| "delete": { |
| "description": "Deletes a developer attribute.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.developers.attributes.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Returns the value of the specified developer attribute.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.attributes.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Returns a list of all developer attributes.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.developers.attributes.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Email address of the developer for which attributes are being listed in the following format: `organizations/{org}/developers/{developer_email}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/attributes", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attributes" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateDeveloperAttribute": { |
| "description": "Updates a developer attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", |
| "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.developers.attributes.updateDeveloperAttribute", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the developer attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "envgroups": { |
| "methods": { |
| "create": { |
| "description": "Creates a new environment group.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.envgroups.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "name": { |
| "description": "ID of the environment group. Overrides any ID in the environment_group resource.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the organization in which to create the environment group in the following format: `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/envgroups", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentGroup" |
| }, |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an environment group.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups/{envgroupsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.envgroups.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/envgroups/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets an environment group.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups/{envgroupsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.envgroups.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/envgroups/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentGroup" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all environment groups.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.envgroups.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "Maximum number of environment groups to return. The page size defaults to 25.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "Page token, returned from a previous ListEnvironmentGroups call, that you can use to retrieve the next page.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the organization for which to list environment groups in the following format: `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/envgroups", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListEnvironmentGroupsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "patch": { |
| "description": "Updates an environment group.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups/{envgroupsId}", |
| "httpMethod": "PATCH", |
| "id": "apigee.organizations.envgroups.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment group to update in the format: `organizations/{org}/envgroups/{envgroup}.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/envgroups/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "description": "List of fields to be updated.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentGroup" |
| }, |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "attachments": { |
| "methods": { |
| "create": { |
| "description": "Creates a new attachment of an environment to an environment group.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.envgroups.attachments.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. EnvironmentGroup under which to create the attachment in the following format: `organizations/{org}/envgroups/{envgroup}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/envgroups/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/attachments", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentGroupAttachment" |
| }, |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an environment group attachment.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.envgroups.attachments.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment group attachment to delete in the following format: `organizations/{org}/envgroups/{envgroup}/attachments/{attachment}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/envgroups/[^/]+/attachments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets an environment group attachment.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.envgroups.attachments.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment group attachment in the following format: `organizations/{org}/envgroups/{envgroup}/attachments/{attachment}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/envgroups/[^/]+/attachments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentGroupAttachment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all attachments of an environment group.", |
| "flatPath": "v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.envgroups.attachments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "Maximum number of environment group attachments to return. The page size defaults to 25.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "Page token, returned by a previous ListEnvironmentGroupAttachments call, that you can use to retrieve the next page.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the organization in the following format: `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/envgroups/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/attachments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "environments": { |
| "methods": { |
| "create": { |
| "description": "Creates an environment in an organization.", |
| "flatPath": "v1/organizations/{organizationsId}/environments", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Optional. Name of the environment. Alternatively, the name may be specified in the request body in the name field.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the organization in which the environment will be created. Use the following structure in your request: `organizations/{org}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/environments", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Environment" |
| }, |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an environment from an organization.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets environment details.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Environment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getDebugmask": { |
| "description": "Gets the debug mask singleton resource for an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.getDebugmask", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the debug mask. Use the following structure in your request: `organizations/{org}/environments/{env}/debugmask`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/debugmask$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DebugMask" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getDeployedConfig": { |
| "description": "Gets the deployed configuration for an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.getDeployedConfig", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment deployed configuration resource. Use the following structure in your request: `organizations/{org}/environments/{env}/deployedConfig`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/deployedConfig$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentConfig" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getIamPolicy": { |
| "description": "Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.getIamPolicy", |
| "parameterOrder": [ |
| "resource" |
| ], |
| "parameters": { |
| "options.requestedPolicyVersion": { |
| "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "resource": { |
| "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+resource}:getIamPolicy", |
| "response": { |
| "$ref": "GoogleIamV1Policy" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "setIamPolicy": { |
| "description": "Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.setIamPolicy", |
| "parameterOrder": [ |
| "resource" |
| ], |
| "parameters": { |
| "resource": { |
| "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+resource}:setIamPolicy", |
| "request": { |
| "$ref": "GoogleIamV1SetIamPolicyRequest" |
| }, |
| "response": { |
| "$ref": "GoogleIamV1Policy" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "subscribe": { |
| "description": "Creates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The \"name\" and \"push_config\" must *not* be specified.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.subscribe", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}:subscribe", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Subscription" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "testIamPermissions": { |
| "description": "Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.testIamPermissions", |
| "parameterOrder": [ |
| "resource" |
| ], |
| "parameters": { |
| "resource": { |
| "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+resource}:testIamPermissions", |
| "request": { |
| "$ref": "GoogleIamV1TestIamPermissionsRequest" |
| }, |
| "response": { |
| "$ref": "GoogleIamV1TestIamPermissionsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "unsubscribe": { |
| "description": "Deletes a subscription for the environment's Pub/Sub topic.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.unsubscribe", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}:unsubscribe", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Subscription" |
| }, |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.environments.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Environment" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Environment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateDebugmask": { |
| "description": "Updates the debug mask singleton resource for an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask", |
| "httpMethod": "PATCH", |
| "id": "apigee.organizations.environments.updateDebugmask", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Name of the debug mask.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/debugmask$", |
| "required": true, |
| "type": "string" |
| }, |
| "replaceRepeatedFields": { |
| "description": "Boolean flag that specifies whether to replace existing values in the debug mask when doing an update. Set to true to replace existing values. The default behavior is to append the values (false).", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "updateMask": { |
| "description": "Field debug mask to support partial updates.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DebugMask" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DebugMask" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateEnvironment": { |
| "description": "Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.updateEnvironment", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Environment" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Environment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "analytics": { |
| "resources": { |
| "admin": { |
| "methods": { |
| "getSchemav2": { |
| "description": "Get a list of metrics and dimensions which can be used for creating analytics queries and reports. Each schema element contains the name of the field with its associated type and if it is either custom field or standard field.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.analytics.admin.getSchemav2", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The parent organization and environment names. Must be of the form `organizations/{org}/environments/{env}/analytics/admin/schemav2`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/analytics/admin/schemav2$", |
| "required": true, |
| "type": "string" |
| }, |
| "type": { |
| "description": "Required. Type refers to the dataset name whose schema needs to be retrieved E.g. type=fact or type=agg_cus1", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Schema" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "exports": { |
| "methods": { |
| "create": { |
| "description": "Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the `state` value of \"enqueued\".", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.analytics.exports.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/analytics/exports", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1ExportRequest" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Export" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets the details and status of an analytics export job. If the export job is still in progress, its `state` is set to \"running\". After the export job has completed successfully, its `state` is set to \"completed\". If the export job fails, its `state` is set to `failed`.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.analytics.exports.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Resource name of the export to get.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/analytics/exports/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Export" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists the details and status of all analytics export jobs belonging to the parent organization and environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.analytics.exports.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/analytics/exports", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListExportsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "apis": { |
| "resources": { |
| "deployments": { |
| "methods": { |
| "list": { |
| "description": "Lists all deployments of an API proxy in an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.apis.deployments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeploymentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "revisions": { |
| "methods": { |
| "deploy": { |
| "description": "Deploys a revision of an API proxy. If an API proxy revision is currently deployed, to ensure seamless deployment with zero downtime set the `override` parameter to `true`. In this case, hybrid attempts to deploy the new revision fully before undeploying the existing revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. ", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.apis.revisions.deploy", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "override": { |
| "description": "Flag that specifies whether the new deployment replaces other deployed revisions of the API proxy in the environment. Set override to true to replace other deployed revisions. By default, override is false and the deployment is rejected if other revisions of the API proxy are deployed in the environment.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "sequencedRollout": { |
| "description": "If true, a best-effort attempt will be made to roll out the routing rules corresponding to this deployment and the environment changes to add this deployment in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a basepath removal. The GenerateDeployChangeReport API may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+name}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Deployment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getDeployments": { |
| "description": "Gets the deployment of an API proxy revision and actual state reported by runtime pods.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.apis.revisions.getDeployments", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Deployment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "undeploy": { |
| "description": "Undeploys an API proxy revision from an environment. Because multiple revisions of the same API proxy can be deployed in the same environment if the base paths are different, you must specify the revision number of the API proxy.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.apis.revisions.undeploy", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "sequencedRollout": { |
| "description": "If true, a best-effort attempt will be made to remove the environment group routing rules corresponding to this deployment before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The GenerateUndeployChangeReport API may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+name}/deployments", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "debugsessions": { |
| "methods": { |
| "create": { |
| "description": "Creates a debug session for a deployed API Proxy revision.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.apis.revisions.debugsessions.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "timeout": { |
| "description": "Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value.", |
| "format": "int64", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/debugsessions", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1DebugSession" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DebugSession" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "deleteData": { |
| "description": "Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.apis.revisions.debugsessions.deleteData", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/data", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Retrieves a debug session.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.apis.revisions.debugsessions.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DebugSession" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists debug sessions that are currently active in the given API Proxy revision.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.apis.revisions.debugsessions.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "Maximum number of debug sessions to return. The page size defaults to 25.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/debugsessions", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDebugSessionsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "data": { |
| "methods": { |
| "get": { |
| "description": "Gets the debug data from a transaction.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.apis.revisions.debugsessions.data.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+/data/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DebugSessionTransaction" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "deployments": { |
| "methods": { |
| "generateDeployChangeReport": { |
| "description": "Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "basepath": { |
| "description": "Base path where the API proxy revision should be deployed. Defaults to '/' if not provided.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "override": { |
| "description": "Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+name}/deployments:generateDeployChangeReport", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeploymentChangeReport" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "generateUndeployChangeReport": { |
| "description": "Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/deployments:generateUndeployChangeReport", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeploymentChangeReport" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "caches": { |
| "methods": { |
| "delete": { |
| "description": "Deletes a cache.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.caches.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Cache resource name of the form: `organizations/{organization_id}/environments/{environment_id}/caches/{cache_id}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/caches/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "deployments": { |
| "methods": { |
| "list": { |
| "description": "Lists all deployments of API proxies or shared flows in an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.deployments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the environment for which to return deployment information in the following format: `organizations/{org}/environments/{env}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "sharedFlows": { |
| "description": "Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+parent}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeploymentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "flowhooks": { |
| "methods": { |
| "attachSharedFlowToFlowHook": { |
| "description": "Attaches a shared flow to a flow hook.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the flow hook to which the shared flow should be attached in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1FlowHook" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1FlowHook" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "detachSharedFlowFromFlowHook": { |
| "description": "Detaches a shared flow from a flow hook.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the flow hook to detach in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1FlowHook" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.flowhooks.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the flow hook in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1FlowHook" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "keystores": { |
| "methods": { |
| "create": { |
| "description": "Creates a keystore or truststore: * Keystore: Contains certificates and their associated keys. * Truststore: Contains trusted certificates used to validate a server's certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.keystores.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Optional. Overrides the value in Keystore.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The name of the environment in which to create the keystore. Must be of the form `organizations/{organization}/environments/{environment}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/keystores", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Keystore" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Keystore" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a keystore or truststore.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.keystores.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of keystore to delete. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Keystore" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets a keystore or truststore.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.keystores.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of keystore. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Keystore" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "aliases": { |
| "methods": { |
| "create": { |
| "description": "Creates an alias from a key, certificate pair. The structure of the request is controlled by the `format` query parameter: * `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. The request must have `Content-Type: multipart/form-data` and include fields `keyFile` and `certFile`. If uploading to a truststore, omit `keyFile`. * `pkcs12` - A PKCS12 file is uploaded. The request must have `Content-Type: multipart/form-data` with the file provided in the only field. * `selfsignedcert` - A new private key and certificate are generated. The request must have `Content-Type: application/json` and a body of CertificateGenerationSpec.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.keystores.aliases.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "_password": { |
| "description": "The password for the private key file, if it exists.", |
| "location": "query", |
| "type": "string" |
| }, |
| "alias": { |
| "description": "The alias for the key, certificate pair. Values must match regular expression `[\\w\\s-.]{1,255}`. This must be provided for all formats except 'selfsignedcert'; self-signed certs may specify the alias in either this parameter or the JSON body.", |
| "location": "query", |
| "type": "string" |
| }, |
| "format": { |
| "description": "Required. The format of the data. Must be either `selfsignedcert`, `keycertfile`, or `pkcs12`.", |
| "location": "query", |
| "type": "string" |
| }, |
| "ignoreExpiryValidation": { |
| "description": "If `true`, no expiry validation will be performed.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "ignoreNewlineValidation": { |
| "description": "If `true`, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. The name of the keystore. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/aliases", |
| "request": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Alias" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "csr": { |
| "description": "Generates a PKCS #10 Certificate Signing Request for the private key in an alias.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.keystores.aliases.csr", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/csr", |
| "response": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an alias.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.keystores.aliases.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Alias" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets an alias.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.keystores.aliases.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Alias" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getCertificate": { |
| "description": "Gets the certificate from an alias in PEM-encoded form.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.keystores.aliases.getCertificate", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/certificate", |
| "response": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates the certificate in an alias.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.environments.keystores.aliases.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "ignoreExpiryValidation": { |
| "description": "Required. If `true`, no expiry validation will be performed.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "ignoreNewlineValidation": { |
| "description": "If `true`, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "name": { |
| "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Alias" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "keyvaluemaps": { |
| "methods": { |
| "create": { |
| "description": "Creates a key value map in an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.keyvaluemaps.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The name of the environment in which to create the key value map. Must be of the form `organizations/{organization}/environments/{environment}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/keyvaluemaps", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Delete a key value map in an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.keyvaluemaps.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the key value map. Must be of the form `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "optimizedStats": { |
| "methods": { |
| "get": { |
| "description": "This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.optimizedStats.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "accuracy": { |
| "description": "Legacy field: not used anymore.", |
| "location": "query", |
| "type": "string" |
| }, |
| "aggTable": { |
| "description": "If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.", |
| "location": "query", |
| "type": "string" |
| }, |
| "filter": { |
| "description": "Enables drill-down on specific dimension values.", |
| "location": "query", |
| "type": "string" |
| }, |
| "limit": { |
| "description": "This parameter is used to limit the number of result items. Default and the max value is 14400.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/environments/{env}/stats/apiproxy,request_verb`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/optimizedStats/.*$", |
| "required": true, |
| "type": "string" |
| }, |
| "offset": { |
| "description": "Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.", |
| "location": "query", |
| "type": "string" |
| }, |
| "realtime": { |
| "description": "Legacy field: not used anymore.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "select": { |
| "description": "Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)", |
| "location": "query", |
| "type": "string" |
| }, |
| "sonar": { |
| "description": "This parameter routes the query to api monitoring service for last hour.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "sort": { |
| "description": "This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.", |
| "location": "query", |
| "type": "string" |
| }, |
| "sortby": { |
| "description": "Comma separated list of columns to sort the final result.", |
| "location": "query", |
| "type": "string" |
| }, |
| "timeRange": { |
| "description": "Required. Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59", |
| "location": "query", |
| "type": "string" |
| }, |
| "timeUnit": { |
| "description": "A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.", |
| "location": "query", |
| "type": "string" |
| }, |
| "topk": { |
| "description": "Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.", |
| "location": "query", |
| "type": "string" |
| }, |
| "tsAscending": { |
| "description": "Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "tzo": { |
| "description": "This parameters contains the timezone offset value.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1OptimizedStats" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "queries": { |
| "methods": { |
| "create": { |
| "description": "Submit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of \"enqueued\" means that the request succeeded.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.queries.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/queries", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Query" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1AsyncQuery" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Get query status If the query is still in progress, the `state` is set to \"running\" After the query has completed successfully, `state` is set to \"completed\"", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.queries.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the asynchronous query to get. Must be of the form `organizations/{org}/environments/{env}/queries/{queryId}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/queries/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1AsyncQuery" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getResult": { |
| "description": "After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip`", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.queries.getResult", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the asynchronous query result to get. Must be of the form `organizations/{org}/environments/{env}/queries/{queryId}/result`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/queries/[^/]+/result$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Return a list of Asynchronous Queries", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.queries.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "dataset": { |
| "description": "Filter response list by dataset. Example: `api`, `mint`", |
| "location": "query", |
| "type": "string" |
| }, |
| "from": { |
| "description": "Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.", |
| "location": "query", |
| "type": "string" |
| }, |
| "inclQueriesWithoutReport": { |
| "description": "Flag to include asynchronous queries that don't have a report denifition.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "status": { |
| "description": "Filter response list by asynchronous query status.", |
| "location": "query", |
| "type": "string" |
| }, |
| "submittedBy": { |
| "description": "Filter response list by user who submitted queries.", |
| "location": "query", |
| "type": "string" |
| }, |
| "to": { |
| "description": "Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/queries", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListAsyncQueriesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "references": { |
| "methods": { |
| "create": { |
| "description": "Creates a Reference in the specified environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.references.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent environment name under which the Reference will be created. Must be of the form `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/references", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Reference" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Reference" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a Reference from an environment. Returns the deleted Reference resource.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.references.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the Reference to delete. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Reference" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets a Reference resource.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.references.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the Reference to get. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Reference" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates an existing Reference. Note that this operation has PUT semantics; it will replace the entirety of the existing Reference with the resource in the request body.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.environments.references.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the Reference to update. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Reference" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Reference" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "resourcefiles": { |
| "methods": { |
| "create": { |
| "description": "Creates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.resourcefiles.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^\u0026{}\\[\\]()+\\-=,.~'` ]{1,255}", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the environment in which to create the resource file in the following format: `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "type": { |
| "description": "Required. Resource file type. {{ resource_file_type }}", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/resourcefiles", |
| "request": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ResourceFile" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.resourcefiles.delete", |
| "parameterOrder": [ |
| "parent", |
| "type", |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^\u0026{}\\[\\]()+\\-=,.~'` ]{1,255}", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "type": { |
| "description": "Required. Resource file type. {{ resource_file_type }}", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/resourcefiles/{type}/{name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ResourceFile" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets the contents of a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.resourcefiles.get", |
| "parameterOrder": [ |
| "parent", |
| "type", |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^\u0026{}\\[\\]()+\\-=,.~'` ]{1,255}", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "type": { |
| "description": "Required. Resource file type. {{ resource_file_type }}", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/resourcefiles/{type}/{name}", |
| "response": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.resourcefiles.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "type": { |
| "description": "Optional. Type of resource files to list. {{ resource_file_type }}", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/resourcefiles", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListEnvironmentResourcesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "listEnvironmentResources": { |
| "description": "Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.resourcefiles.listEnvironmentResources", |
| "parameterOrder": [ |
| "parent", |
| "type" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "type": { |
| "description": "Optional. Type of resource files to list. {{ resource_file_type }}", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/resourcefiles/{type}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListEnvironmentResourcesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.environments.resourcefiles.update", |
| "parameterOrder": [ |
| "parent", |
| "type", |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^\u0026{}\\[\\]()+\\-=,.~'` ]{1,255}", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "type": { |
| "description": "Required. Resource file type. {{ resource_file_type }}", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/resourcefiles/{type}/{name}", |
| "request": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ResourceFile" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "sharedflows": { |
| "resources": { |
| "deployments": { |
| "methods": { |
| "list": { |
| "description": "Lists all deployments of a shared flow in an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.sharedflows.deployments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeploymentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "revisions": { |
| "methods": { |
| "deploy": { |
| "description": "Deploys a revision of a shared flow. If a shared flow revision is currently deployed, to ensure seamless deployment with zero downtime set the `override` parameter to `true`. In this case, hybrid attempts to deply the new revision fully before undeploying the existing revision. You cannot use a shared flows until it has been deployed to an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.sharedflows.revisions.deploy", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "override": { |
| "description": "Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks. If an existing shared flow revision is deployed, to ensure seamless deployment with no downtime, set this parameter to `true`. In this case, hybrid deploys the new revision fully before undeploying the existing revision. If set to `false`, you must undeploy the existing revision before deploying the new revision.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+name}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Deployment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "getDeployments": { |
| "description": "Gets the deployment of a shared flow revision and actual state reported by runtime pods.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.sharedflows.revisions.getDeployments", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Deployment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "undeploy": { |
| "description": "Undeploys a shared flow revision from an environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.sharedflows.revisions.undeploy", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/deployments", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "stats": { |
| "methods": { |
| "get": { |
| "description": "Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.stats.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "accuracy": { |
| "description": "Legacy field: not used anymore. This field is present to support UI calls which still use this parameter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "aggTable": { |
| "description": "If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.", |
| "location": "query", |
| "type": "string" |
| }, |
| "filter": { |
| "description": "Enables drill-down on specific dimension values", |
| "location": "query", |
| "type": "string" |
| }, |
| "limit": { |
| "description": "This parameter is used to limit the number of result items. Default and the max value is 14400.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/environments/{env}/stats/apiproxy,request_verb`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/stats/.*$", |
| "required": true, |
| "type": "string" |
| }, |
| "offset": { |
| "description": "Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.", |
| "location": "query", |
| "type": "string" |
| }, |
| "realtime": { |
| "description": "Legacy field: not used anymore.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "select": { |
| "description": "The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)", |
| "location": "query", |
| "type": "string" |
| }, |
| "sonar": { |
| "description": "This parameter routes the query to api monitoring service for last hour.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "sort": { |
| "description": "This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.", |
| "location": "query", |
| "type": "string" |
| }, |
| "sortby": { |
| "description": "Comma separated list of columns to sort the final result.", |
| "location": "query", |
| "type": "string" |
| }, |
| "timeRange": { |
| "description": "Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59", |
| "location": "query", |
| "type": "string" |
| }, |
| "timeUnit": { |
| "description": "A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.", |
| "location": "query", |
| "type": "string" |
| }, |
| "topk": { |
| "description": "Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.", |
| "location": "query", |
| "type": "string" |
| }, |
| "tsAscending": { |
| "description": "Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "tzo": { |
| "description": "This parameters contains the timezone offset value.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Stats" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "targetservers": { |
| "methods": { |
| "create": { |
| "description": "Creates a TargetServer in the specified environment.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.environments.targetservers.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The parent environment name under which the TargetServer will be created. Must be of the form `organizations/{org}/environments/{env}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/targetservers", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1TargetServer" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1TargetServer" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.environments.targetservers.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the TargetServer to delete. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1TargetServer" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets a TargetServer resource.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.environments.targetservers.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the TargetServer to get. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1TargetServer" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.", |
| "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.environments.targetservers.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the TargetServer to replace. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1TargetServer" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1TargetServer" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "instances": { |
| "methods": { |
| "create": { |
| "description": "Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.", |
| "flatPath": "v1/organizations/{organizationsId}/instances", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.instances.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/instances", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1Instance" |
| }, |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid.", |
| "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.instances.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instance/{instance}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/instances/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid.", |
| "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.instances.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/instances/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1Instance" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.", |
| "flatPath": "v1/organizations/{organizationsId}/instances", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.instances.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "Maximum number of instances to return. Defaults to 25.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/instances", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListInstancesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "reportStatus": { |
| "description": "Reports the latest status for a runtime instance.", |
| "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.instances.reportStatus", |
| "parameterOrder": [ |
| "instance" |
| ], |
| "parameters": { |
| "instance": { |
| "description": "The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance}", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/instances/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+instance}:reportStatus", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1ReportInstanceStatusRequest" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ReportInstanceStatusResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "attachments": { |
| "methods": { |
| "create": { |
| "description": "Creates a new attachment of an environment to an instance. **Note:** Not supported for Apigee hybrid.", |
| "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}/attachments", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.instances.attachments.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/instances/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/attachments", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1InstanceAttachment" |
| }, |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an attachment. **Note:** Not supported for Apigee hybrid.", |
| "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.instances.attachments.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the attachment. Use the following structure in your request: `organizations/{org}/instances/{instance}/attachments/{attachment}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/instances/[^/]+/attachments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets an attachment. **Note:** Not supported for Apigee hybrid.", |
| "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.instances.attachments.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the attachment. Use the following structure in your request: `organizations/{org}/instances/{instance}/attachments/{attachment}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/instances/[^/]+/attachments/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1InstanceAttachment" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all attachments to an instance. **Note:** Not supported for Apigee hybrid.", |
| "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}/attachments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.instances.attachments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "Maximum number of instance attachments to return. Defaults to 25.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "Page token, returned by a previous ListInstanceAttachments call, that you can use to retrieve the next page of content.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/instances/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/attachments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListInstanceAttachmentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "keyvaluemaps": { |
| "methods": { |
| "create": { |
| "description": "Creates a key value map in an organization.", |
| "flatPath": "v1/organizations/{organizationsId}/keyvaluemaps", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.keyvaluemaps.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The name of the organization in which to create the key value map file. Must be of the form `organizations/{organization}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/keyvaluemaps", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Delete a key value map in an organization.", |
| "flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.keyvaluemaps.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the key value map. Must be of the form `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1KeyValueMap" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "operations": { |
| "methods": { |
| "get": { |
| "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", |
| "flatPath": "v1/organizations/{organizationsId}/operations/{operationsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.operations.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/operations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", |
| "flatPath": "v1/organizations/{organizationsId}/operations", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.operations.list", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "filter": { |
| "description": "The standard list filter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The name of the operation's parent resource.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "pageSize": { |
| "description": "The standard list page size.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "The standard list page token.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}/operations", |
| "response": { |
| "$ref": "GoogleLongrunningListOperationsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "reports": { |
| "methods": { |
| "create": { |
| "description": "Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.", |
| "flatPath": "v1/organizations/{organizationsId}/reports", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.reports.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent organization name under which the Custom Report will be created. Must be of the form: `organizations/{organization_id}/reports`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/reports", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1CustomReport" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1CustomReport" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an existing custom report definition", |
| "flatPath": "v1/organizations/{organizationsId}/reports/{reportsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.reports.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/reports/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1DeleteCustomReportResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Retrieve a custom report definition.", |
| "flatPath": "v1/organizations/{organizationsId}/reports/{reportsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.reports.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/reports/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1CustomReport" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Return a list of Custom Reports", |
| "flatPath": "v1/organizations/{organizationsId}/reports", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.reports.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "expand": { |
| "description": "Set to 'true' to get expanded details about each custom report.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. The parent organization name under which the API product will be listed `organizations/{organization_id}/reports`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/reports", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListCustomReportsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "update": { |
| "description": "Update an existing custom report definition", |
| "flatPath": "v1/organizations/{organizationsId}/reports/{reportsId}", |
| "httpMethod": "PUT", |
| "id": "apigee.organizations.reports.update", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/reports/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleCloudApigeeV1CustomReport" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1CustomReport" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "sharedflows": { |
| "methods": { |
| "create": { |
| "description": "Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.sharedflows.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "action": { |
| "description": "Required. Must be set to either `import` or `validate`.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. The name to give the shared flow", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/sharedflows", |
| "request": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1SharedFlowRevision" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.sharedflows.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1SharedFlow" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets a shared flow by name, including a list of its revisions.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.sharedflows.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1SharedFlow" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all shared flows in the organization.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.sharedflows.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "includeMetaData": { |
| "description": "Indicates whether to include shared flow metadata in the response.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "includeRevisions": { |
| "description": "Indicates whether to include a list of revisions in the response.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/sharedflows", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListSharedFlowsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "deployments": { |
| "methods": { |
| "list": { |
| "description": "Lists all deployments of a shared flow.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.sharedflows.deployments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeploymentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "revisions": { |
| "methods": { |
| "delete": { |
| "description": "Deletes a shared flow and all associated policies, resources, and revisions. You must undeploy the shared flow before deleting it.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}", |
| "httpMethod": "DELETE", |
| "id": "apigee.organizations.sharedflows.revisions.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1SharedFlowRevision" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets a revision of a shared flow. If `format=bundle` is passed, it instead outputs a shared flow revision as a ZIP-formatted bundle of code and config files.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.sharedflows.revisions.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "format": { |
| "description": "Specify `bundle` to export the contents of the shared flow bundle. Otherwise, the bundle metadata is returned.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "updateSharedFlowRevision": { |
| "description": "Updates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable, even if it becomes undeployed. The payload is a ZIP-formatted shared flow. Content type must be either multipart/form-data or application/octet-stream.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}", |
| "httpMethod": "POST", |
| "id": "apigee.organizations.sharedflows.revisions.updateSharedFlowRevision", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "validate": { |
| "description": "Ignored. All uploads are validated regardless of the value of this field. It is kept for compatibility with existing APIs. Must be `true` or `false` if provided.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "GoogleApiHttpBody" |
| }, |
| "response": { |
| "$ref": "GoogleCloudApigeeV1SharedFlowRevision" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "deployments": { |
| "methods": { |
| "list": { |
| "description": "Lists all deployments of a shared flow revision.", |
| "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments", |
| "httpMethod": "GET", |
| "id": "apigee.organizations.sharedflows.revisions.deployments.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.", |
| "location": "path", |
| "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/deployments", |
| "response": { |
| "$ref": "GoogleCloudApigeeV1ListDeploymentsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "revision": "20200902", |
| "rootUrl": "https://apigee.googleapis.com/", |
| "schemas": { |
| "GoogleApiHttpBody": { |
| "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", |
| "id": "GoogleApiHttpBody", |
| "properties": { |
| "contentType": { |
| "description": "The HTTP Content-Type header value specifying the content type of the body.", |
| "type": "string" |
| }, |
| "data": { |
| "description": "The HTTP request/response body as raw binary.", |
| "format": "byte", |
| "type": "string" |
| }, |
| "extensions": { |
| "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", |
| "items": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Access": { |
| "id": "GoogleCloudApigeeV1Access", |
| "properties": { |
| "Get": { |
| "$ref": "GoogleCloudApigeeV1AccessGet" |
| }, |
| "Remove": { |
| "$ref": "GoogleCloudApigeeV1AccessRemove" |
| }, |
| "Set": { |
| "$ref": "GoogleCloudApigeeV1AccessSet" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1AccessGet": { |
| "description": "Get action. For example, \"Get\" : { \"name\" : \"target.name\", \"value\" : \"default\" }", |
| "id": "GoogleCloudApigeeV1AccessGet", |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "value": { |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1AccessRemove": { |
| "description": "Remove action. For example, \"Remove\" : { \"name\" : \"target.name\", \"success\" : true }", |
| "id": "GoogleCloudApigeeV1AccessRemove", |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "success": { |
| "type": "boolean" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1AccessSet": { |
| "description": "Set action. For example, \"Set\" : { \"name\" : \"target.name\", \"success\" : true, \"value\" : \"default\" }", |
| "id": "GoogleCloudApigeeV1AccessSet", |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "success": { |
| "type": "boolean" |
| }, |
| "value": { |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Alias": { |
| "description": "A reference to a certificate or key, certificate pair.", |
| "id": "GoogleCloudApigeeV1Alias", |
| "properties": { |
| "alias": { |
| "description": "The resource ID for this alias. Values must match regular expression `[^/]{1,255}`.", |
| "type": "string" |
| }, |
| "certsInfo": { |
| "$ref": "GoogleCloudApigeeV1Certificate", |
| "description": "The chain of certificates under this alias." |
| }, |
| "type": { |
| "description": "The type of alias.", |
| "enum": [ |
| "ALIAS_TYPE_UNSPECIFIED", |
| "CERT", |
| "KEY_CERT" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "" |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1AliasRevisionConfig": { |
| "id": "GoogleCloudApigeeV1AliasRevisionConfig", |
| "properties": { |
| "location": { |
| "description": "Location of the alias file. For example, a Google Cloud Storage URI.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the alias revision included in the keystore in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}`", |
| "type": "string" |
| }, |
| "type": { |
| "enum": [ |
| "ALIAS_TYPE_UNSPECIFIED", |
| "CERT", |
| "KEY_CERT" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "" |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ApiProduct": { |
| "id": "GoogleCloudApigeeV1ApiProduct", |
| "properties": { |
| "apiResources": { |
| "description": "Comma-separated list of API resources to be bundled in the API Product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see: - Manage API products - Managing a transaction recording policy using the API", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "approvalType": { |
| "description": "Specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in \"pending\" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in \"approved\" state and can be used immediately. *NOTE:* Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.", |
| "type": "string" |
| }, |
| "attributes": { |
| "description": "Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal but can be accessed by external developers. For monetization, you can use the attributes field to: - Specify transaction success criteria - Specify custom attributes on which you base rate plan charges.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| }, |
| "createdAt": { |
| "description": "Response only. Creation time of this environment as milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "description": { |
| "description": "An overview of the API product. Include key information about the API product that is not captured by other fields.", |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "The name to be displayed in the UI or developer portal to developers registering for API access.", |
| "type": "string" |
| }, |
| "environments": { |
| "description": "A comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in 'prod' from being accessed by API proxies deployed in 'test'.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "lastModifiedAt": { |
| "description": "Response only. Modified time of this environment as milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The internal name of the API Product. Characters you can use in the name are restricted to: A-Z0-9._\\-$ %. *NOTE:* The internal name cannot be edited when updating the API product.", |
| "type": "string" |
| }, |
| "operationGroup": { |
| "$ref": "GoogleCloudApigeeV1OperationGroup", |
| "description": "The operation_group enables api product creators to group Apigee proxies or remote services with resources, method types and quotas. The resource refers to the resource URI(excluding the base path). With this grouping, API product creator is able to finetune and give precise control over which REST methods have access to which resources, and how many such calls can be made (via Quota). Note that api_resources cannot be specified at both the API product level as well as within the operation_group. If configured that way, the call will fail. Please refer go/api-product-with-methods for additional details." |
| }, |
| "proxies": { |
| "description": "A comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Edge rejects requests to API proxies that are not listed. *NOTE:* The API proxy names must already exist in the specified environment as they will be validated upon creation.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "quota": { |
| "description": "The number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.", |
| "type": "string" |
| }, |
| "quotaInterval": { |
| "description": "The time interval over which the number of request messages is calculated.", |
| "type": "string" |
| }, |
| "quotaTimeUnit": { |
| "description": "The time unit defined for the `quotaInterval`. Valid values include minute, hour, day, or month.", |
| "type": "string" |
| }, |
| "scopes": { |
| "description": "A comma-separated list of OAuth scopes that are validated at runtime. Edge validates that the scopes in any access token presented match the scopes defined in the OAuth policy assoicated with the API product.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ApiProductRef": { |
| "id": "GoogleCloudApigeeV1ApiProductRef", |
| "properties": { |
| "apiproduct": { |
| "description": "Name of the API product.", |
| "type": "string" |
| }, |
| "status": { |
| "description": "Status of the API product.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ApiProxy": { |
| "description": "Metadata describing the API proxy", |
| "id": "GoogleCloudApigeeV1ApiProxy", |
| "properties": { |
| "latestRevisionId": { |
| "description": "The id of the most recently created revision for this api proxy.", |
| "type": "string" |
| }, |
| "metaData": { |
| "$ref": "GoogleCloudApigeeV1EntityMetadata", |
| "description": "Metadata describing the API proxy." |
| }, |
| "name": { |
| "description": "Name of the API proxy.", |
| "type": "string" |
| }, |
| "revision": { |
| "description": "List of revisons defined for the API proxy.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ApiProxyRevision": { |
| "description": "API proxy revision.", |
| "id": "GoogleCloudApigeeV1ApiProxyRevision", |
| "properties": { |
| "basepaths": { |
| "description": "Base URL of the API proxy.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "configurationVersion": { |
| "$ref": "GoogleCloudApigeeV1ConfigVersion", |
| "description": "Version of the API proxy configuration schema to which the API proxy conforms. Currently, the only supported value is 4.0 (`majorVersion.minorVersion`). This setting may be used in the future to track the evolution of the API proxy format." |
| }, |
| "contextInfo": { |
| "description": "Revision number, app name, and organization for the API proxy.", |
| "type": "string" |
| }, |
| "createdAt": { |
| "description": "Time that the API proxy revision was created in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "description": { |
| "description": "Description of the API proxy revision.", |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Human-readable name of the API proxy.", |
| "type": "string" |
| }, |
| "entityMetaDataAsProperties": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "Metadata describing the API proxy revision as a key-value map.", |
| "type": "object" |
| }, |
| "lastModifiedAt": { |
| "description": "Time that the API proxy revision was last modified in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the API proxy.", |
| "type": "string" |
| }, |
| "policies": { |
| "description": "List of policy names included in the API proxy revision..", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "proxies": { |
| "description": "List of proxy names included in the API proxy revision.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "proxyEndpoints": { |
| "description": "List of ProxyEndpoints in the `/proxies` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "resourceFiles": { |
| "$ref": "GoogleCloudApigeeV1ResourceFiles", |
| "description": "List of resource files included in the API proxy revision." |
| }, |
| "resources": { |
| "description": "List of the resources included in the API proxy revision formatted as \"{type}://{name}\".", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "revision": { |
| "description": "API proxy revision.", |
| "type": "string" |
| }, |
| "sharedFlows": { |
| "description": "List of the shared flows included in the API proxy revision.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "spec": { |
| "description": "OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store.", |
| "type": "string" |
| }, |
| "targetEndpoints": { |
| "description": "List of TargetEndpoints in the `/targets` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "targetServers": { |
| "description": "List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "targets": { |
| "description": "List of the targets included in the API proxy revision.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "teams": { |
| "description": "List of the teams included in the API proxy revision.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "type": { |
| "description": "Type. Set to `Application`. Maintained for compatibility with the Apigee Edge API.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1App": { |
| "id": "GoogleCloudApigeeV1App", |
| "properties": { |
| "apiProducts": { |
| "description": "List of API products associated with the app.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ApiProductRef" |
| }, |
| "type": "array" |
| }, |
| "appId": { |
| "description": "ID of the app.", |
| "type": "string" |
| }, |
| "attributes": { |
| "description": "List of attributes.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| }, |
| "callbackUrl": { |
| "description": "Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.", |
| "type": "string" |
| }, |
| "companyName": { |
| "description": "Name of the company that owns the app.", |
| "type": "string" |
| }, |
| "createdAt": { |
| "description": "Output only. Unix time when the app was created.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "credentials": { |
| "description": "Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Credential" |
| }, |
| "readOnly": true, |
| "type": "array" |
| }, |
| "developerId": { |
| "description": "ID of the developer.", |
| "type": "string" |
| }, |
| "keyExpiresIn": { |
| "description": "Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn", |
| "format": "int64", |
| "type": "string" |
| }, |
| "lastModifiedAt": { |
| "description": "Output only. Last modified time as milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the app.", |
| "type": "string" |
| }, |
| "scopes": { |
| "description": "Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "status": { |
| "description": "Status of the credential.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1AsyncQuery": { |
| "id": "GoogleCloudApigeeV1AsyncQuery", |
| "properties": { |
| "created": { |
| "description": "Creation time of the query.", |
| "type": "string" |
| }, |
| "error": { |
| "description": "Error is set when query fails.", |
| "type": "string" |
| }, |
| "executionTime": { |
| "description": "ExecutionTime is available only after the query is completed.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Asynchronous Query Name.", |
| "type": "string" |
| }, |
| "queryParams": { |
| "$ref": "GoogleCloudApigeeV1QueryMetadata", |
| "description": "Contains information like metrics, dimenstions etc of the AsyncQuery." |
| }, |
| "reportDefinitionId": { |
| "description": "Asynchronous Report ID.", |
| "type": "string" |
| }, |
| "result": { |
| "$ref": "GoogleCloudApigeeV1AsyncQueryResult", |
| "description": "Result is available only after the query is completed." |
| }, |
| "resultFileSize": { |
| "description": "ResultFileSize is available only after the query is completed.", |
| "type": "string" |
| }, |
| "resultRows": { |
| "description": "ResultRows is available only after the query is completed.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "self": { |
| "description": "Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`", |
| "type": "string" |
| }, |
| "state": { |
| "description": "Query state could be \"enqueued\", \"running\", \"completed\", \"failed\".", |
| "type": "string" |
| }, |
| "updated": { |
| "description": "Last updated timestamp for the query.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1AsyncQueryResult": { |
| "id": "GoogleCloudApigeeV1AsyncQueryResult", |
| "properties": { |
| "expires": { |
| "description": "Query result will be unaccessable after this time.", |
| "type": "string" |
| }, |
| "self": { |
| "description": "Self link of the query results. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Attribute": { |
| "description": "Key-value pair to store extra metadata.", |
| "id": "GoogleCloudApigeeV1Attribute", |
| "properties": { |
| "name": { |
| "description": "API key of the attribute.", |
| "type": "string" |
| }, |
| "value": { |
| "description": "Value of the attribute.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Attributes": { |
| "id": "GoogleCloudApigeeV1Attributes", |
| "properties": { |
| "attribute": { |
| "description": "List of attributes.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1CertInfo": { |
| "description": "An X.509 certificate as defined in RFC 5280.", |
| "id": "GoogleCloudApigeeV1CertInfo", |
| "properties": { |
| "basicConstraints": { |
| "description": "The X.509 basic constraints extension.", |
| "type": "string" |
| }, |
| "expiryDate": { |
| "description": "The X.509 validity / notAfter in milliseconds since the epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "isValid": { |
| "description": "\"Yes\" if certificate is valid, \"No\" if expired and \"Not yet\" if not yet valid.", |
| "type": "string" |
| }, |
| "issuer": { |
| "description": "The X.509 issuer.", |
| "type": "string" |
| }, |
| "publicKey": { |
| "description": "The public key component of the X.509 subject public key info.", |
| "type": "string" |
| }, |
| "serialNumber": { |
| "description": "The X.509 serial number.", |
| "type": "string" |
| }, |
| "sigAlgName": { |
| "description": "The X.509 signatureAlgorithm.", |
| "type": "string" |
| }, |
| "subject": { |
| "description": "The X.509 subject.", |
| "type": "string" |
| }, |
| "subjectAlternativeNames": { |
| "description": "The X.509 subject alternative names (SANs) extension.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "validFrom": { |
| "description": "The X.509 validity / notBefore in milliseconds since the epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "version": { |
| "description": "The X.509 version.", |
| "format": "int32", |
| "type": "integer" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Certificate": { |
| "id": "GoogleCloudApigeeV1Certificate", |
| "properties": { |
| "certInfo": { |
| "description": "The chain of certificates under this name.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1CertInfo" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1CommonNameConfig": { |
| "id": "GoogleCloudApigeeV1CommonNameConfig", |
| "properties": { |
| "matchWildCards": { |
| "type": "boolean" |
| }, |
| "name": { |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ConfigVersion": { |
| "description": "Version of the API proxy configuration schema. Currently, only 4.0 is supported.", |
| "id": "GoogleCloudApigeeV1ConfigVersion", |
| "properties": { |
| "majorVersion": { |
| "description": "Major version of the API proxy configuration schema.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "minorVersion": { |
| "description": "Minor version of the API proxy configuration schema.", |
| "format": "int32", |
| "type": "integer" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Credential": { |
| "id": "GoogleCloudApigeeV1Credential", |
| "properties": { |
| "apiProducts": { |
| "description": "List of API products this credential can be used for.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ApiProductRef" |
| }, |
| "type": "array" |
| }, |
| "attributes": { |
| "description": "List of attributes associated with this credential.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| }, |
| "consumerKey": { |
| "description": "Consumer key.", |
| "type": "string" |
| }, |
| "consumerSecret": { |
| "description": "Secret key.", |
| "type": "string" |
| }, |
| "expiresAt": { |
| "description": "Time the credential will expire in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "issuedAt": { |
| "description": "Time the credential was issued in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "scopes": { |
| "description": "List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "status": { |
| "description": "Status of the credential.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1CustomReport": { |
| "id": "GoogleCloudApigeeV1CustomReport", |
| "properties": { |
| "chartType": { |
| "description": "This field contains the chart type for the report", |
| "type": "string" |
| }, |
| "comments": { |
| "description": "Legacy field: not used. This field contains a list of comments associated with custom report", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "createdAt": { |
| "description": "Output only. Unix time when the app was created json key: createdAt", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "dimensions": { |
| "description": "This contains the list of dimensions for the report", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "displayName": { |
| "description": "This is the display name for the report", |
| "type": "string" |
| }, |
| "environment": { |
| "description": "Output only. Environment name", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "filter": { |
| "description": "This field contains the filter expression", |
| "type": "string" |
| }, |
| "fromTime": { |
| "description": "Legacy field: not used. Contains the from time for the report", |
| "type": "string" |
| }, |
| "lastModifiedAt": { |
| "description": "Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "lastViewedAt": { |
| "description": "Output only. Last viewed time of this entity as milliseconds since epoch", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "limit": { |
| "description": "Legacy field: not used This field contains the limit for the result retrieved", |
| "type": "string" |
| }, |
| "metrics": { |
| "description": "Required. This contains the list of metrics", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1CustomReportMetric" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id", |
| "type": "string" |
| }, |
| "offset": { |
| "description": "Legacy field: not used. This field contains the offset for the data", |
| "type": "string" |
| }, |
| "organization": { |
| "description": "Output only. Organization name", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "properties": { |
| "description": "This field contains report properties such as ui metadata etc.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ReportProperty" |
| }, |
| "type": "array" |
| }, |
| "sortByCols": { |
| "description": "Legacy field: not used much. Contains the list of sort by columns", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "sortOrder": { |
| "description": "Legacy field: not used much. Contains the sort order for the sort columns", |
| "type": "string" |
| }, |
| "tags": { |
| "description": "Legacy field: not used. This field contains a list of tags associated with custom report", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "timeUnit": { |
| "description": "This field contains the time unit of aggregation for the report", |
| "type": "string" |
| }, |
| "toTime": { |
| "description": "Legacy field: not used. Contains the end time for the report", |
| "type": "string" |
| }, |
| "topk": { |
| "description": "Legacy field: not used. This field contains the top k parameter value for restricting the result", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1CustomReportMetric": { |
| "description": "This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum", |
| "id": "GoogleCloudApigeeV1CustomReportMetric", |
| "properties": { |
| "function": { |
| "description": "aggregate function", |
| "type": "string" |
| }, |
| "name": { |
| "description": "name of the metric", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DataCollectorConfig": { |
| "description": "Data collector and its configuration.", |
| "id": "GoogleCloudApigeeV1DataCollectorConfig", |
| "properties": { |
| "name": { |
| "description": "Name of the data collector in the following format: `organizations/{org}/datacollectors/{datacollector}`", |
| "type": "string" |
| }, |
| "type": { |
| "description": "Data type accepted by the data collector.", |
| "enum": [ |
| "TYPE_UNSPECIFIED", |
| "INTEGER", |
| "FLOAT", |
| "STRING", |
| "BOOLEAN", |
| "DATETIME" |
| ], |
| "enumDescriptions": [ |
| "For future compatibility.", |
| "For integer values.", |
| "For float values.", |
| "For string values.", |
| "For boolean values.", |
| "For datetime values." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Datastore": { |
| "description": "The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.", |
| "id": "GoogleCloudApigeeV1Datastore", |
| "properties": { |
| "createTime": { |
| "description": "Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "datastoreConfig": { |
| "$ref": "GoogleCloudApigeeV1DatastoreConfig", |
| "description": "Datastore Configurations." |
| }, |
| "displayName": { |
| "description": "Required. Display name in UI", |
| "type": "string" |
| }, |
| "lastUpdateTime": { |
| "description": "Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "org": { |
| "description": "Output only. Organization that the datastore belongs to", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "self": { |
| "description": "Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "targetType": { |
| "description": "Destination storage type. Supported types `gcs` or `bigquery`.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DatastoreConfig": { |
| "description": "Configuration detail for datastore", |
| "id": "GoogleCloudApigeeV1DatastoreConfig", |
| "properties": { |
| "bucketName": { |
| "description": "Name of the Cloud Storage bucket. Required for `gcs` target_type.", |
| "type": "string" |
| }, |
| "datasetName": { |
| "description": "BigQuery dataset name Required for `bigquery` target_type.", |
| "type": "string" |
| }, |
| "path": { |
| "description": "Path of Cloud Storage bucket Required for `gcs` target_type.", |
| "type": "string" |
| }, |
| "projectId": { |
| "description": "Required. GCP project in which the datastore exists", |
| "type": "string" |
| }, |
| "tablePrefix": { |
| "description": "Prefix of BigQuery table Required for `bigquery` target_type.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DateRange": { |
| "description": "Date range of the data to export.", |
| "id": "GoogleCloudApigeeV1DateRange", |
| "properties": { |
| "end": { |
| "description": "Required. End date (exclusive) of the data to export in the format `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.", |
| "type": "string" |
| }, |
| "start": { |
| "description": "Required. Start date of the data to export in the format `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start date.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DebugMask": { |
| "id": "GoogleCloudApigeeV1DebugMask", |
| "properties": { |
| "faultJSONPaths": { |
| "description": "List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "faultXPaths": { |
| "description": "List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "Name of the debug mask.", |
| "type": "string" |
| }, |
| "namespaces": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "Map of namespaces to URIs.", |
| "type": "object" |
| }, |
| "requestJSONPaths": { |
| "description": "List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "requestXPaths": { |
| "description": "List of XPaths that specify the XML elements to be filtered from XML request message payloads.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "responseJSONPaths": { |
| "description": "List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "responseXPaths": { |
| "description": "List of XPaths that specify the XML elements to be filtered from XML response message payloads.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "variables": { |
| "description": "List of variables that should be masked from the debug output.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DebugSession": { |
| "id": "GoogleCloudApigeeV1DebugSession", |
| "properties": { |
| "count": { |
| "description": "Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "filter": { |
| "description": "Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "A unique ID for this DebugSession.", |
| "type": "string" |
| }, |
| "timeout": { |
| "description": "Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "tracesize": { |
| "description": "Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "validity": { |
| "description": "Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.", |
| "format": "int32", |
| "type": "integer" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DebugSessionTransaction": { |
| "description": "A transaction contains all of the debug information of the entire message flow of an API call processed by the runtime plane. The information is collected and recorded at critical points of the message flow in the runtime apiproxy.", |
| "id": "GoogleCloudApigeeV1DebugSessionTransaction", |
| "properties": { |
| "completed": { |
| "description": "Flag indicating whether a transaction is completed or not", |
| "type": "boolean" |
| }, |
| "point": { |
| "description": "List of debug data collected by runtime plane at various defined points in the flow.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Point" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DeleteCustomReportResponse": { |
| "id": "GoogleCloudApigeeV1DeleteCustomReportResponse", |
| "properties": { |
| "message": { |
| "description": "The response contains only a message field.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Deployment": { |
| "id": "GoogleCloudApigeeV1Deployment", |
| "properties": { |
| "apiProxy": { |
| "description": "API proxy.", |
| "type": "string" |
| }, |
| "basePath": { |
| "description": "Base path for the deployment.", |
| "type": "string" |
| }, |
| "deployStartTime": { |
| "description": "Time the API proxy was marked `deployed` in the control plane in millisconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "environment": { |
| "description": "Environment.", |
| "type": "string" |
| }, |
| "errors": { |
| "description": "Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs.", |
| "items": { |
| "$ref": "GoogleRpcStatus" |
| }, |
| "type": "array" |
| }, |
| "instances": { |
| "description": "Status reported by each runtime instance. This field is not populated in List APIs.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1InstanceDeploymentStatus" |
| }, |
| "type": "array" |
| }, |
| "pods": { |
| "description": "Status reported by runtime pods. This field is not populated for List APIs.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1PodStatus" |
| }, |
| "type": "array" |
| }, |
| "revision": { |
| "description": "API proxy revision.", |
| "type": "string" |
| }, |
| "routeConflicts": { |
| "description": "Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be ERROR, but it will mean that some of the deployments basepaths are not routed to its environment. If the conflicts change, the state will transition to PROGRESSING until the latest configuration is rolled out to all instances. This field is not populated in List APIs.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict" |
| }, |
| "type": "array" |
| }, |
| "state": { |
| "description": "Current state of the deployment. This field is not populated in List APIs.", |
| "enum": [ |
| "RUNTIME_STATE_UNSPECIFIED", |
| "READY", |
| "PROGRESSING", |
| "ERROR" |
| ], |
| "enumDescriptions": [ |
| "This value should never be returned.", |
| "The runtime has loaded the deployment.", |
| "The deployment is not fully ready in the runtime.", |
| "There is an error with the deployment that requires intervention." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DeploymentChangeReport": { |
| "description": "Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment. The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are: 1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments. 2) To warn users if some basepath in the proxy will not receive traffic due to an existing deployment having already claimed that basepath. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected.", |
| "id": "GoogleCloudApigeeV1DeploymentChangeReport", |
| "properties": { |
| "routingChanges": { |
| "description": "All routing changes that may result from a deployment request.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1DeploymentChangeReportRoutingChange" |
| }, |
| "type": "array" |
| }, |
| "routingConflicts": { |
| "description": "All basepath conflicts detected for a deployment request.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict" |
| }, |
| "type": "array" |
| }, |
| "validationErrors": { |
| "$ref": "GoogleRpcPreconditionFailure", |
| "description": "Validation errors that would cause the deployment change request to be rejected." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DeploymentChangeReportRoutingChange": { |
| "description": "Describes a potential routing change that may occur as a result of some deployment operation.", |
| "id": "GoogleCloudApigeeV1DeploymentChangeReportRoutingChange", |
| "properties": { |
| "description": { |
| "description": "A human-readable description of this routing change.", |
| "type": "string" |
| }, |
| "environmentGroup": { |
| "description": "The name of the environment group affected by this routing change.", |
| "type": "string" |
| }, |
| "fromDeployment": { |
| "$ref": "GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment", |
| "description": "The basepath/deployment that may stop receiving some traffic." |
| }, |
| "shouldSequenceRollout": { |
| "description": "True if using sequenced rollout would make this routing change safer. Note: this does not necessarily imply that automated sequenced rollout mode is supported for the operation.", |
| "type": "boolean" |
| }, |
| "toDeployment": { |
| "$ref": "GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment", |
| "description": "The basepath/deployment that may start receiving that traffic. May be null if no deployment is able to receive the traffic." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict": { |
| "description": "Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.", |
| "id": "GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict", |
| "properties": { |
| "conflictingDeployment": { |
| "$ref": "GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment", |
| "description": "The existing basepath/deployment causing the conflict." |
| }, |
| "description": { |
| "description": "A human-readable description of this conflict.", |
| "type": "string" |
| }, |
| "environmentGroup": { |
| "description": "The name of the environment group in which this conflict exists.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment": { |
| "description": "A tuple representing a basepath and the deployment containing it.", |
| "id": "GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment", |
| "properties": { |
| "apiProxy": { |
| "description": "The name of the deployed proxy revision containing the basepath.", |
| "type": "string" |
| }, |
| "basepath": { |
| "description": "The basepath receiving traffic.", |
| "type": "string" |
| }, |
| "environment": { |
| "description": "The name of the environment in which the proxy is deployed.", |
| "type": "string" |
| }, |
| "revision": { |
| "description": "The name of the deployed proxy revision containing the basepath.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DeploymentConfig": { |
| "id": "GoogleCloudApigeeV1DeploymentConfig", |
| "properties": { |
| "attributes": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "Additional key-value metadata for the deployment.", |
| "type": "object" |
| }, |
| "basePath": { |
| "description": "Base path where the application will be hosted. Defaults to \"/\".", |
| "type": "string" |
| }, |
| "location": { |
| "description": "Location of the API proxy bundle as a URI.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the API or shared flow revision to be deployed in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`", |
| "type": "string" |
| }, |
| "proxyUid": { |
| "description": "Unique ID of the API proxy revision.", |
| "type": "string" |
| }, |
| "uid": { |
| "description": "Unique ID. The ID will only change if the deployment is deleted and recreated.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Developer": { |
| "id": "GoogleCloudApigeeV1Developer", |
| "properties": { |
| "accessType": { |
| "description": "Access type.", |
| "type": "string" |
| }, |
| "appFamily": { |
| "description": "Developer app family.", |
| "type": "string" |
| }, |
| "apps": { |
| "description": "List of apps associated with the developer.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "attributes": { |
| "description": "Optional. Developer attributes (name/value pairs). The custom attribute limit is 18.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| }, |
| "companies": { |
| "description": "List of companies associated with the developer.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "createdAt": { |
| "description": "Output only. Time at which the developer was created in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "developerId": { |
| "description": "ID of the developer. **Note**: IDs are generated internally by Apigee and are not guaranteed to stay the same over time.", |
| "type": "string" |
| }, |
| "email": { |
| "description": "Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid.", |
| "type": "string" |
| }, |
| "firstName": { |
| "description": "Required. First name of the developer.", |
| "type": "string" |
| }, |
| "lastModifiedAt": { |
| "description": "Output only. Time at which the developer was last modified in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "lastName": { |
| "description": "Required. Last name of the developer.", |
| "type": "string" |
| }, |
| "organizationName": { |
| "description": "Output only. Name of the Apigee organization in which the developer resides.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "status": { |
| "description": "Output only. Status of the developer. Valid values are `active` and `inactive`.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "userName": { |
| "description": "Required. User name of the developer. Not used by Apigee hybrid.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DeveloperApp": { |
| "id": "GoogleCloudApigeeV1DeveloperApp", |
| "properties": { |
| "apiProducts": { |
| "description": "List of API products associated with the developer app.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "appFamily": { |
| "description": "Developer app family.", |
| "type": "string" |
| }, |
| "appId": { |
| "description": "ID of the developer app.", |
| "type": "string" |
| }, |
| "attributes": { |
| "description": "List of attributes for the developer app.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| }, |
| "callbackUrl": { |
| "description": "Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.", |
| "type": "string" |
| }, |
| "createdAt": { |
| "description": "Output only. Time the developer app was created in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "credentials": { |
| "description": "Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Credential" |
| }, |
| "readOnly": true, |
| "type": "array" |
| }, |
| "developerId": { |
| "description": "ID of the developer.", |
| "type": "string" |
| }, |
| "keyExpiresIn": { |
| "description": "Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "lastModifiedAt": { |
| "description": "Output only. Time the developer app was modified in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the developer app.", |
| "type": "string" |
| }, |
| "scopes": { |
| "description": "Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "status": { |
| "description": "Status of the credential. Valid values include `approved` or `revoked`.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DeveloperAppKey": { |
| "id": "GoogleCloudApigeeV1DeveloperAppKey", |
| "properties": { |
| "apiProducts": { |
| "description": "List of API products for which the credential can be used. **Note**: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.", |
| "items": { |
| "type": "any" |
| }, |
| "type": "array" |
| }, |
| "attributes": { |
| "description": "List of attributes associated with the credential.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| }, |
| "consumerKey": { |
| "description": "Consumer key.", |
| "type": "string" |
| }, |
| "consumerSecret": { |
| "description": "Secret key.", |
| "type": "string" |
| }, |
| "expiresAt": { |
| "description": "Time the developer app expires in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "issuedAt": { |
| "description": "Time the developer app was created in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "scopes": { |
| "description": "Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "status": { |
| "description": "Status of the credential. Valid values include `approved` or `revoked`.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1DimensionMetric": { |
| "description": "This message type encapsulates a metric grouped by dimension.", |
| "id": "GoogleCloudApigeeV1DimensionMetric", |
| "properties": { |
| "metrics": { |
| "description": "This field contains a list of metrics.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Metric" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "This field contains the name of the dimension.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1EntityMetadata": { |
| "description": "Metadata common to many entities in this API.", |
| "id": "GoogleCloudApigeeV1EntityMetadata", |
| "properties": { |
| "createdAt": { |
| "description": "Time at which the API proxy was created, in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "lastModifiedAt": { |
| "description": "Time at which the API proxy was most recently modified, in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "subType": { |
| "description": "The type of entity described", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Environment": { |
| "id": "GoogleCloudApigeeV1Environment", |
| "properties": { |
| "createdAt": { |
| "description": "Output only. Creation time of this environment as milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "description": { |
| "description": "Optional. Description of the environment.", |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Optional. Display name for this environment.", |
| "type": "string" |
| }, |
| "lastModifiedAt": { |
| "description": "Output only. Last modification time of this environment as milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. Name of the environment. Values must match the regular expression `^[.\\\\p{Alnum}-_]{1,255}$`", |
| "type": "string" |
| }, |
| "properties": { |
| "$ref": "GoogleCloudApigeeV1Properties", |
| "description": "Optional. Key-value pairs that may be used for customizing the environment." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1EnvironmentConfig": { |
| "id": "GoogleCloudApigeeV1EnvironmentConfig", |
| "properties": { |
| "createTime": { |
| "description": "Time that the environment configuration was created.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "dataCollectors": { |
| "description": "List of data collectors used by the deployments in the environment.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1DataCollectorConfig" |
| }, |
| "type": "array" |
| }, |
| "debugMask": { |
| "$ref": "GoogleCloudApigeeV1DebugMask", |
| "description": "Debug mask that applies to all deployments in the environment." |
| }, |
| "deployments": { |
| "description": "List of deployments in the environment.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1DeploymentConfig" |
| }, |
| "type": "array" |
| }, |
| "featureFlags": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "Feature flags inherited from the organization and environment.", |
| "type": "object" |
| }, |
| "flowhooks": { |
| "description": "List of flow hooks in the environment.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1FlowHookConfig" |
| }, |
| "type": "array" |
| }, |
| "keystores": { |
| "description": "List of keystores in the environment.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1KeystoreConfig" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}`", |
| "type": "string" |
| }, |
| "provider": { |
| "description": "Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging.", |
| "type": "string" |
| }, |
| "pubsubTopic": { |
| "description": "Name of the PubSub topic for the environment.", |
| "type": "string" |
| }, |
| "resourceReferences": { |
| "description": "List of resource references in the environment.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ReferenceConfig" |
| }, |
| "type": "array" |
| }, |
| "resources": { |
| "description": "List of resource versions in the environment.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ResourceConfig" |
| }, |
| "type": "array" |
| }, |
| "revisionId": { |
| "description": "Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "sequenceNumber": { |
| "description": "DEPRECATED: Use revision_id.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "targets": { |
| "description": "List of target servers in the environment. Disabled target servers are not displayed.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1TargetServerConfig" |
| }, |
| "type": "array" |
| }, |
| "uid": { |
| "description": "Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1EnvironmentGroup": { |
| "description": "EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.", |
| "id": "GoogleCloudApigeeV1EnvironmentGroup", |
| "properties": { |
| "createdAt": { |
| "description": "Output only. The time at which the environment group was created as milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "hostnames": { |
| "description": "Required. Host names for this environment group.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "lastModifiedAt": { |
| "description": "Output only. The time at which the environment group was last updated as milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "ID of the environment group.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1EnvironmentGroupAttachment": { |
| "description": "EnvironmentGroupAttachment is a resource which defines an attachment of an environment to an environment group.", |
| "id": "GoogleCloudApigeeV1EnvironmentGroupAttachment", |
| "properties": { |
| "createdAt": { |
| "description": "Output only. The time at which the environment group attachment was created as milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "environment": { |
| "description": "Required. ID of the attached environment.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "ID of the environment group attachment.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1EnvironmentGroupConfig": { |
| "description": "EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.", |
| "id": "GoogleCloudApigeeV1EnvironmentGroupConfig", |
| "properties": { |
| "hostnames": { |
| "description": "Host names for the environment group.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.", |
| "type": "string" |
| }, |
| "revisionId": { |
| "description": "Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "routingRules": { |
| "description": "Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1RoutingRule" |
| }, |
| "type": "array" |
| }, |
| "uid": { |
| "description": "A unique id for the environment group config that will only change if the environment group is deleted and recreated.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Export": { |
| "description": "Details of an export job.", |
| "id": "GoogleCloudApigeeV1Export", |
| "properties": { |
| "created": { |
| "description": "Output only. Time the export job was created.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "datastoreName": { |
| "description": "Name of the datastore that is the destination of the export job [datastore]", |
| "type": "string" |
| }, |
| "description": { |
| "description": "Description of the export job.", |
| "type": "string" |
| }, |
| "error": { |
| "description": "Output only. Error is set when export fails", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "executionTime": { |
| "description": "Output only. Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed since`created`, in seconds. Else, it will set to (`updated` - `created`), in seconds.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Display name of the export job.", |
| "type": "string" |
| }, |
| "self": { |
| "description": "Output only. Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "state": { |
| "description": "Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "updated": { |
| "description": "Output only. Time the export job was last updated.", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ExportRequest": { |
| "description": "Request body for [CreateExportRequest]", |
| "id": "GoogleCloudApigeeV1ExportRequest", |
| "properties": { |
| "csvDelimiter": { |
| "description": "Optional. Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\\t`).", |
| "type": "string" |
| }, |
| "datastoreName": { |
| "description": "Required. Name of the preconfigured datastore.", |
| "type": "string" |
| }, |
| "dateRange": { |
| "$ref": "GoogleCloudApigeeV1DateRange", |
| "description": "Required. Date range of the data to export." |
| }, |
| "description": { |
| "description": "Optional. Description of the export job.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. Display name of the export job.", |
| "type": "string" |
| }, |
| "outputFormat": { |
| "description": "Optional. Output format of the export. Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the `csvDelimiter` property.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1FlowHook": { |
| "id": "GoogleCloudApigeeV1FlowHook", |
| "properties": { |
| "continueOnError": { |
| "description": "Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to `true` to continue execution. Set to `false` to stop execution if the flow hook throws an exception.Defaults to `true`.", |
| "type": "boolean" |
| }, |
| "description": { |
| "description": "Description of the flow hook.", |
| "type": "string" |
| }, |
| "flowHookPoint": { |
| "description": "Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "sharedFlow": { |
| "description": "Shared flow attached to this flow hook, or empty if there is none attached.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1FlowHookConfig": { |
| "id": "GoogleCloudApigeeV1FlowHookConfig", |
| "properties": { |
| "continueOnError": { |
| "description": "Flag that specifies whether the flow should abort after an error in the flow hook. Defaults to `true` (continue on error).", |
| "type": "boolean" |
| }, |
| "name": { |
| "description": "Name of the flow hook in the following format: `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, and `PostTargetFlowHook`", |
| "type": "string" |
| }, |
| "sharedFlowName": { |
| "description": "Name of the shared flow to invoke in the following format: `organizations/{org}/sharedflows/{sharedflow}`", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1GetSyncAuthorizationRequest": { |
| "description": "Request for GetSyncAuthorization.", |
| "id": "GoogleCloudApigeeV1GetSyncAuthorizationRequest", |
| "properties": {}, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1IngressConfig": { |
| "id": "GoogleCloudApigeeV1IngressConfig", |
| "properties": { |
| "environmentGroups": { |
| "description": "List of environment groups in the organization.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentGroupConfig" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`.", |
| "type": "string" |
| }, |
| "revisionCreateTime": { |
| "description": "Time at which the IngressConfig revision was created.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "revisionId": { |
| "description": "Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "uid": { |
| "description": "A unique id for the ingress config that will only change if the organization is deleted and recreated.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Instance": { |
| "description": "Apigee runtime instance.", |
| "id": "GoogleCloudApigeeV1Instance", |
| "properties": { |
| "createdAt": { |
| "description": "Output only. Time the instance was created in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "description": { |
| "description": "Optional. Description of the instance.", |
| "type": "string" |
| }, |
| "diskEncryptionKeyName": { |
| "description": "Optional. Customer Managed Encryption Key (CMEK) used for disk \u0026 volume encryption.", |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Optional. Display name for the instance.", |
| "type": "string" |
| }, |
| "host": { |
| "description": "Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "lastModifiedAt": { |
| "description": "Output only. Time the instance was last modified in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "location": { |
| "description": "Required. Compute Engine location where the instance resides.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\\d]$`.", |
| "type": "string" |
| }, |
| "port": { |
| "description": "Output only. Port number of the exposed Apigee endpoint.", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1InstanceAttachment": { |
| "description": "InstanceAttachment represents the installation of an environment onto an instance.", |
| "id": "GoogleCloudApigeeV1InstanceAttachment", |
| "properties": { |
| "createdAt": { |
| "description": "Output only. Time the attachment was created in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "environment": { |
| "description": "ID of the attached environment.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. ID of the attachment.", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1InstanceDeploymentStatus": { |
| "description": "The status of a deployment as reported by a single instance.", |
| "id": "GoogleCloudApigeeV1InstanceDeploymentStatus", |
| "properties": { |
| "deployedRevisions": { |
| "description": "Revisions currently deployed in MPs.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision" |
| }, |
| "type": "array" |
| }, |
| "deployedRoutes": { |
| "description": "The current routes deployed in the ingress routing table. A route which is missing will be shown with no destination environment.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute" |
| }, |
| "type": "array" |
| }, |
| "instance": { |
| "description": "ID of the instance reporting the status.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision": { |
| "description": "Revisions deployed in the MPs.", |
| "id": "GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision", |
| "properties": { |
| "percentage": { |
| "description": "The percentage of MP replicas reporting this revision", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "revision": { |
| "description": "The proxy revision reported as deployed.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute": { |
| "description": "A route deployed in the ingress routing table.", |
| "id": "GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute", |
| "properties": { |
| "basepath": { |
| "description": "The basepath in the routing table.", |
| "type": "string" |
| }, |
| "envgroup": { |
| "description": "The envgroup where this route is installed.", |
| "type": "string" |
| }, |
| "environment": { |
| "description": "The destination environment. This will be empty if the route is not yet reported.", |
| "type": "string" |
| }, |
| "percentage": { |
| "description": "The percentage of ingress replicas reporting this route.", |
| "format": "int32", |
| "type": "integer" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1KeyAliasReference": { |
| "id": "GoogleCloudApigeeV1KeyAliasReference", |
| "properties": { |
| "aliasId": { |
| "description": "Alias ID. Must exist in the keystore referred to by the reference.", |
| "type": "string" |
| }, |
| "reference": { |
| "description": "Reference name in the following format: `organizations/{org}/environments/{env}/references/{reference}`", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1KeyValueMap": { |
| "description": "A collection of key, value string pairs", |
| "id": "GoogleCloudApigeeV1KeyValueMap", |
| "properties": { |
| "encrypted": { |
| "description": "Optional. If `true` entry values will be encrypted.", |
| "type": "boolean" |
| }, |
| "name": { |
| "description": "Required. The id of the key value map.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Keystore": { |
| "description": "A datastore for Certificates and Aliases", |
| "id": "GoogleCloudApigeeV1Keystore", |
| "properties": { |
| "aliases": { |
| "description": "Output only. The aliases in this keystore.", |
| "items": { |
| "type": "string" |
| }, |
| "readOnly": true, |
| "type": "array" |
| }, |
| "name": { |
| "description": "Required. The resource ID for this keystore. Values must match the regular expression `[\\w[:space:]-.]{1,255}`.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1KeystoreConfig": { |
| "id": "GoogleCloudApigeeV1KeystoreConfig", |
| "properties": { |
| "aliases": { |
| "description": "Aliases in the keystore.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1AliasRevisionConfig" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "Resource name in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}`", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListApiProductsResponse": { |
| "id": "GoogleCloudApigeeV1ListApiProductsResponse", |
| "properties": { |
| "apiProduct": { |
| "description": "Lists all API product names defined for an organization.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ApiProduct" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListApiProxiesResponse": { |
| "id": "GoogleCloudApigeeV1ListApiProxiesResponse", |
| "properties": { |
| "proxies": { |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ApiProxy" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListAppsResponse": { |
| "id": "GoogleCloudApigeeV1ListAppsResponse", |
| "properties": { |
| "app": { |
| "items": { |
| "$ref": "GoogleCloudApigeeV1App" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListAsyncQueriesResponse": { |
| "description": "The response for ListAsyncQueries.", |
| "id": "GoogleCloudApigeeV1ListAsyncQueriesResponse", |
| "properties": { |
| "queries": { |
| "description": "The asynchronous queries belong to requested resource name.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1AsyncQuery" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListCustomReportsResponse": { |
| "description": "This message encapsulates a list of custom report definitions", |
| "id": "GoogleCloudApigeeV1ListCustomReportsResponse", |
| "properties": { |
| "qualifier": { |
| "items": { |
| "$ref": "GoogleCloudApigeeV1CustomReport" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListDatastoresResponse": { |
| "description": "The response for ListDatastores", |
| "id": "GoogleCloudApigeeV1ListDatastoresResponse", |
| "properties": { |
| "datastores": { |
| "description": "A list of datastores", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Datastore" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListDebugSessionsResponse": { |
| "id": "GoogleCloudApigeeV1ListDebugSessionsResponse", |
| "properties": { |
| "nextPageToken": { |
| "description": "Page token that you can include in a ListDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist.", |
| "type": "string" |
| }, |
| "sessions": { |
| "description": "Session info that includes debug session ID and the first transaction creation timestamp.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Session" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListDeploymentsResponse": { |
| "id": "GoogleCloudApigeeV1ListDeploymentsResponse", |
| "properties": { |
| "deployments": { |
| "description": "List of deployments.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Deployment" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListDeveloperAppsResponse": { |
| "id": "GoogleCloudApigeeV1ListDeveloperAppsResponse", |
| "properties": { |
| "app": { |
| "description": "List of developer apps and their credentials.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1DeveloperApp" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse": { |
| "description": "Response for ListEnvironmentGroupAttachments.", |
| "id": "GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse", |
| "properties": { |
| "environmentGroupAttachments": { |
| "description": "EnvironmentGroupAttachments for the specified environment group.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentGroupAttachment" |
| }, |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "Page token that you can include in a ListEnvironmentGroupAttachments request to retrieve the next page. If omitted, no subsequent pages exist.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListEnvironmentGroupsResponse": { |
| "description": "Response for ListEnvironmentGroups.", |
| "id": "GoogleCloudApigeeV1ListEnvironmentGroupsResponse", |
| "properties": { |
| "environmentGroups": { |
| "description": "EnvironmentGroups in the specified organization.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1EnvironmentGroup" |
| }, |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "Page token that you can include in a ListEnvironmentGroups request to retrieve the next page. If omitted, no subsequent pages exist.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListEnvironmentResourcesResponse": { |
| "description": "Response for ListEnvironmentResources", |
| "id": "GoogleCloudApigeeV1ListEnvironmentResourcesResponse", |
| "properties": { |
| "resourceFile": { |
| "description": "List of resources files.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ResourceFile" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListExportsResponse": { |
| "description": "The response for ListExports", |
| "id": "GoogleCloudApigeeV1ListExportsResponse", |
| "properties": { |
| "exports": { |
| "description": "Details of the export jobs.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Export" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListHybridIssuersResponse": { |
| "id": "GoogleCloudApigeeV1ListHybridIssuersResponse", |
| "properties": { |
| "issuers": { |
| "description": "Lists of hybrid services and its trusted issuer email ids.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ServiceIssuersMapping" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListInstanceAttachmentsResponse": { |
| "description": "Response for ListInstanceAttachments.", |
| "id": "GoogleCloudApigeeV1ListInstanceAttachmentsResponse", |
| "properties": { |
| "attachments": { |
| "description": "Attachments for the instance.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1InstanceAttachment" |
| }, |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "Page token that you can include in a ListInstanceAttachments request to retrieve the next page of content. If omitted, no subsequent pages exist.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListInstancesResponse": { |
| "description": "Response for ListInstances.", |
| "id": "GoogleCloudApigeeV1ListInstancesResponse", |
| "properties": { |
| "instances": { |
| "description": "Instances in the specified organization.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Instance" |
| }, |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListOfDevelopersResponse": { |
| "id": "GoogleCloudApigeeV1ListOfDevelopersResponse", |
| "properties": { |
| "developer": { |
| "description": "List of developers.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Developer" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListOrganizationsResponse": { |
| "id": "GoogleCloudApigeeV1ListOrganizationsResponse", |
| "properties": { |
| "organizations": { |
| "description": "List of Apigee organizations and associated GCP projects.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1OrganizationProjectMapping" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ListSharedFlowsResponse": { |
| "id": "GoogleCloudApigeeV1ListSharedFlowsResponse", |
| "properties": { |
| "sharedFlows": { |
| "items": { |
| "$ref": "GoogleCloudApigeeV1SharedFlow" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Metadata": { |
| "description": "This message type encapsulates additional information about query execution.", |
| "id": "GoogleCloudApigeeV1Metadata", |
| "properties": { |
| "errors": { |
| "description": "List of error messages as strings.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "notices": { |
| "description": "List of additional information such as data source, if result was truncated etc. E.g \"notices\": [ \"Source:Postgres\", \"PG Host:uappg0rw.e2e.apigeeks.net\", \"query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed\", \"Table used: edge.api.uapgroup2.agg_api\" ]", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Metric": { |
| "description": "This message type encapsulates the metric data point. Example: { \"name\": \"sum(message_count)\", \"values\" : [ { \"timestamp\": 1549004400000, \"value\": \"39.0\" }, { \"timestamp\" : 1548997200000, \"value\" : \"0.0\" } ] } or { \"name\": \"sum(message_count)\", \"values\" : [\"39.0\"] }", |
| "id": "GoogleCloudApigeeV1Metric", |
| "properties": { |
| "name": { |
| "description": "This field contains the metric name.", |
| "type": "string" |
| }, |
| "values": { |
| "description": "List of metric values. Possible value format: \"values\":[\"39.0\"] or \"values\":[ { \"value\": \"39.0\", \"timestamp\": 1232434354} ]", |
| "items": { |
| "type": "any" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Operation": { |
| "description": "Operation represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.", |
| "id": "GoogleCloudApigeeV1Operation", |
| "properties": { |
| "methods": { |
| "description": "methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "resource": { |
| "description": "Required. resource represents REST resource path associated with the proxy/remote service.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1OperationConfig": { |
| "description": "OperationConfig binds the resources in a proxy or remote service with the allowed REST methods and its associated quota enforcement.", |
| "id": "GoogleCloudApigeeV1OperationConfig", |
| "properties": { |
| "apiSource": { |
| "description": "Required. api_source represents either a proxy or remote service name for which the resources, methods and quota are associated with.", |
| "type": "string" |
| }, |
| "attributes": { |
| "description": "custom attribute associated with the operation.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| }, |
| "operations": { |
| "description": "operations is the list of resource/methods pair, belonging to proxy/remote service, upon which quota will applied on. Note that currently we allow only a single operation. The call will fail if more than one is provided.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Operation" |
| }, |
| "type": "array" |
| }, |
| "quota": { |
| "$ref": "GoogleCloudApigeeV1Quota", |
| "description": "Quota parameters to be enforced for the resources, methods, api_source combination. If none specified, quota enforcement will not be done." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1OperationGroup": { |
| "description": "The OperationGroup contains a list of configuration details associated with Apigee proxies or Remote services. Remote services are non-Apigee Edge proxies. eg, Istio-Envoy.", |
| "id": "GoogleCloudApigeeV1OperationGroup", |
| "properties": { |
| "operationConfigType": { |
| "description": "Identfies whether the configuration is for Apigee proxy or a remote service. Possible values are \"proxy\" and \"remote_service\". If none specified, the default is \"proxy\". \"proxy\" is used when Apigee proxies are associated with the API product. \"remote_service\" is used when non-Apigee proxy like Envoy is used, and is associated with the API product.", |
| "type": "string" |
| }, |
| "operationConfigs": { |
| "description": "Required. A list of OperationConfig for either Apigee proxies or other other remote services, that are associated with this API product.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1OperationConfig" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1OperationMetadata": { |
| "description": "Metadata describing an Operation.", |
| "id": "GoogleCloudApigeeV1OperationMetadata", |
| "properties": { |
| "operationType": { |
| "enum": [ |
| "OPERATION_TYPE_UNSPECIFIED", |
| "INSERT", |
| "DELETE", |
| "UPDATE" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "" |
| ], |
| "type": "string" |
| }, |
| "state": { |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "NOT_STARTED", |
| "IN_PROGRESS", |
| "FINISHED" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "" |
| ], |
| "type": "string" |
| }, |
| "targetResourceName": { |
| "description": "Name of the resource for which the operation is operating on.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1OptimizedStats": { |
| "id": "GoogleCloudApigeeV1OptimizedStats", |
| "properties": { |
| "Response": { |
| "$ref": "GoogleCloudApigeeV1OptimizedStatsResponse", |
| "description": "This field wraps the stats response for Js Optimized Scenario with a Response key. E.g. { \"Response\": { \"TimeUnit\": [], \"metaData\": { \"errors\": [], \"notices\": [ \"Source:Postgres\", \"Table used: edge.api.aaxgroup001.agg_api\", \"PG Host:ruappg08-ro.production.apigeeks.net\", \"query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca\" ] }, \"resultTruncated\": false, \"stats\": { \"data\": [ { \"identifier\": { \"names\": [ \"apiproxy\" ], \"values\": [ \"sirjee\" ] }, \"metric\": [ { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] }, { \"env\": \"prod\", \"name\": \"sum(is_error)\", \"values\": [ 36.0 ] } ] } ] } } }" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1OptimizedStatsNode": { |
| "description": "This message type encapsulates a data node as represented below: { \"identifier\": { \"names\": [ \"apiproxy\" ], \"values\": [ \"sirjee\" ] }, \"metric\": [ { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] } ] } OR { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] } Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics.", |
| "id": "GoogleCloudApigeeV1OptimizedStatsNode", |
| "properties": { |
| "data": { |
| "items": { |
| "type": "any" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1OptimizedStatsResponse": { |
| "description": "This message type encapsulates a response format for Js Optimized Scenario.", |
| "id": "GoogleCloudApigeeV1OptimizedStatsResponse", |
| "properties": { |
| "TimeUnit": { |
| "description": "This field contains a list of time unit values. Time unit refers to an epoch timestamp value.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "metaData": { |
| "$ref": "GoogleCloudApigeeV1Metadata", |
| "description": "This field contains metadata information about the query executed" |
| }, |
| "resultTruncated": { |
| "description": "This ia a boolean field to indicate if the results were truncated based on the limit parameter.", |
| "type": "boolean" |
| }, |
| "stats": { |
| "$ref": "GoogleCloudApigeeV1OptimizedStatsNode", |
| "description": "This field contains a stats results." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Organization": { |
| "id": "GoogleCloudApigeeV1Organization", |
| "properties": { |
| "analyticsRegion": { |
| "description": "Required. Primary GCP region for analytics data storage. For valid values, see [Create an organization](https://docs.apigee.com/hybrid/latest/precog-provision).", |
| "type": "string" |
| }, |
| "attributes": { |
| "description": "Not used by Apigee.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "authorizedNetwork": { |
| "description": "Compute Engine network used for ServiceNetworking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType] is set to CLOUD. The value can be updated only when there are no runtime instances. For example: \"default\". **Note:** Not supported for Apigee hybrid.", |
| "type": "string" |
| }, |
| "caCertificate": { |
| "description": "Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType] is CLOUD.", |
| "format": "byte", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "createdAt": { |
| "description": "Output only. Time that the Apigee organization was created in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "customerName": { |
| "description": "Not used by Apigee.", |
| "type": "string" |
| }, |
| "description": { |
| "description": "Description of the Apigee organization.", |
| "type": "string" |
| }, |
| "displayName": { |
| "type": "string" |
| }, |
| "environments": { |
| "description": "Output only. List of environments in the Apigee organization.", |
| "items": { |
| "type": "string" |
| }, |
| "readOnly": true, |
| "type": "array" |
| }, |
| "lastModifiedAt": { |
| "description": "Output only. Time that the Apigee organization was last modified in milliseconds since epoch.", |
| "format": "int64", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Name of the Apigee organization.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "projectId": { |
| "description": "The project ID associated with the Apigee organization.", |
| "type": "string" |
| }, |
| "properties": { |
| "$ref": "GoogleCloudApigeeV1Properties", |
| "description": "Properties defined in the Apigee organization profile." |
| }, |
| "runtimeType": { |
| "description": "Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.", |
| "enum": [ |
| "RUNTIME_TYPE_UNSPECIFIED", |
| "CLOUD", |
| "HYBRID" |
| ], |
| "enumDescriptions": [ |
| "", |
| "Google-managed Apigee runtime.", |
| "User-managed Apigee hybrid runtime." |
| ], |
| "type": "string" |
| }, |
| "subscriptionType": { |
| "description": "Output only. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/).", |
| "enum": [ |
| "SUBSCRIPTION_TYPE_UNSPECIFIED", |
| "PAID", |
| "TRIAL" |
| ], |
| "enumDescriptions": [ |
| "", |
| "Full subscription to Apigee has been purchased.", |
| "Subscription to Apigee is free, limited, and used for evaluation purposes only." |
| ], |
| "readOnly": true, |
| "type": "string" |
| }, |
| "type": { |
| "description": "Not used by Apigee.", |
| "enum": [ |
| "TYPE_UNSPECIFIED", |
| "TYPE_TRIAL", |
| "TYPE_PAID", |
| "TYPE_INTERNAL" |
| ], |
| "enumDescriptions": [ |
| "Subscription type not specified.", |
| "Subscription to Apigee is free, limited, and used for evaluation purposes only.", |
| "Full subscription to Apigee has been purchased. See [Apigee pricing](https://cloud.google.com/apigee/pricing/).", |
| "For internal users only." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1OrganizationProjectMapping": { |
| "id": "GoogleCloudApigeeV1OrganizationProjectMapping", |
| "properties": { |
| "organization": { |
| "description": "Name of the Apigee organization.", |
| "type": "string" |
| }, |
| "projectIds": { |
| "description": "List of GCP projects associated with the Apigee organization.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1PodStatus": { |
| "id": "GoogleCloudApigeeV1PodStatus", |
| "properties": { |
| "appVersion": { |
| "description": "Version of the application running in the pod.", |
| "type": "string" |
| }, |
| "deploymentStatus": { |
| "description": "Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment.", |
| "type": "string" |
| }, |
| "deploymentStatusTime": { |
| "description": "Time the deployment status was reported in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "deploymentTime": { |
| "description": "Time the proxy was deployed in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "podName": { |
| "description": "Name of the pod which is reporting the status.", |
| "type": "string" |
| }, |
| "podStatus": { |
| "description": "Overall status of the pod (not this specific deployment). Valid values include: - `active`: Up to date. - `stale` : Recently out of date. Pods that have not reported status in a long time are excluded from the output.", |
| "type": "string" |
| }, |
| "podStatusTime": { |
| "description": "Time the pod status was reported in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "statusCode": { |
| "description": "Code associated with the deployment status.", |
| "type": "string" |
| }, |
| "statusCodeDetails": { |
| "description": "Human-readable message associated with the status code.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Point": { |
| "description": "Point is a group of information collected by runtime plane at critical points of the message flow of the processed API request. This is a list of supported point IDs, categorized to three major buckets. For each category, debug points that we are currently supporting are listed below: - Flow status debug points: StateChange FlowInfo Condition Execution DebugMask Error - Flow control debug points: FlowCallout Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition Oauth2ServicePoint RaiseFault NodeJS The detail information of the given debug point is stored in a list of results.", |
| "id": "GoogleCloudApigeeV1Point", |
| "properties": { |
| "id": { |
| "description": "Name of a step in the transaction.", |
| "type": "string" |
| }, |
| "results": { |
| "description": "List of results extracted from a given debug point.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Result" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Properties": { |
| "description": "Message for compatibility with legacy Edge specification for Java Properties object in JSON.", |
| "id": "GoogleCloudApigeeV1Properties", |
| "properties": { |
| "property": { |
| "description": "List of all properties in the object", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Property" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Property": { |
| "description": "A single property entry in the Properties message.", |
| "id": "GoogleCloudApigeeV1Property", |
| "properties": { |
| "name": { |
| "description": "The property key", |
| "type": "string" |
| }, |
| "value": { |
| "description": "The property value", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Query": { |
| "id": "GoogleCloudApigeeV1Query", |
| "properties": { |
| "csvDelimiter": { |
| "description": "Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\\t`).", |
| "type": "string" |
| }, |
| "dimensions": { |
| "description": "A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "filter": { |
| "description": "Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax", |
| "type": "string" |
| }, |
| "groupByTimeUnit": { |
| "description": "Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.", |
| "type": "string" |
| }, |
| "limit": { |
| "description": "Maximum number of rows that can be returned in the result.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "metrics": { |
| "description": "A list of Metrics.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1QueryMetric" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "Asynchronous Query Name.", |
| "type": "string" |
| }, |
| "outputFormat": { |
| "description": "Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.", |
| "type": "string" |
| }, |
| "reportDefinitionId": { |
| "description": "Asynchronous Report ID.", |
| "type": "string" |
| }, |
| "timeRange": { |
| "description": "Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: \"timeRange\": { \"start\": \"2018-07-29T00:13:00Z\", \"end\": \"2018-08-01T00:18:00Z\" }", |
| "type": "any" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1QueryMetadata": { |
| "id": "GoogleCloudApigeeV1QueryMetadata", |
| "properties": { |
| "dimensions": { |
| "description": "Dimensions of the AsyncQuery.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "endTimestamp": { |
| "description": "End timestamp of the query range.", |
| "type": "string" |
| }, |
| "metrics": { |
| "description": "Metrics of the AsyncQuery. Example: [\"name:message_count,func:sum,alias:sum_message_count\"]", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "outputFormat": { |
| "description": "Output format.", |
| "type": "string" |
| }, |
| "startTimestamp": { |
| "description": "Start timestamp of the query range.", |
| "type": "string" |
| }, |
| "timeUnit": { |
| "description": "Query GroupBy time unit.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1QueryMetric": { |
| "description": "More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics", |
| "id": "GoogleCloudApigeeV1QueryMetric", |
| "properties": { |
| "alias": { |
| "description": "Alias for the metric. Alias will be used to replace metric name in query results.", |
| "type": "string" |
| }, |
| "function": { |
| "description": "Aggregation function: avg, min, max, or sum.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. Metric name.", |
| "type": "string" |
| }, |
| "operator": { |
| "description": "One of `+`, `-`, `/`, `%`, `*`.", |
| "type": "string" |
| }, |
| "value": { |
| "description": "Operand value should be provided when operator is set.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Quota": { |
| "description": "Quota contains the essential parameters needed that can be applied on a proxy/remote service, resources and methods combination associated with this API product. While setting of Quota is optional, setting it prevents requests from exceeding the provisioned parameters.", |
| "id": "GoogleCloudApigeeV1Quota", |
| "properties": { |
| "interval": { |
| "description": "Required. The time interval over which the number of request messages is calculated.", |
| "type": "string" |
| }, |
| "limit": { |
| "description": "Required. Limit represents the upper bound count allowed for the time interval and time unit specified. Requests exceeding this limit will get rejected.", |
| "type": "string" |
| }, |
| "timeUnit": { |
| "description": "The time unit defined for the `interval`. Valid values include minute, hour, day, or month. The default value is empty. If limit and interval are valid, the default value is \"hour\".", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Reference": { |
| "description": "A Reference configuration. References must refer to a keystore that also exists in the parent environment.", |
| "id": "GoogleCloudApigeeV1Reference", |
| "properties": { |
| "description": { |
| "description": "Optional. A human-readable description of this reference.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Required. The resource id of this reference. Values must match the regular expression [\\w\\s\\-.]+.", |
| "type": "string" |
| }, |
| "refers": { |
| "description": "Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.", |
| "type": "string" |
| }, |
| "resourceType": { |
| "description": "The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ReferenceConfig": { |
| "id": "GoogleCloudApigeeV1ReferenceConfig", |
| "properties": { |
| "name": { |
| "description": "Name of the reference in the following format: `organizations/{org}/environments/{env}/references/{reference}`", |
| "type": "string" |
| }, |
| "resourceName": { |
| "description": "Name of the referenced resource in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` Only references to keystore resources are supported.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ReportInstanceStatusRequest": { |
| "description": "Request for ReportInstanceStatus.", |
| "id": "GoogleCloudApigeeV1ReportInstanceStatusRequest", |
| "properties": { |
| "instanceUid": { |
| "description": "A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID.", |
| "type": "string" |
| }, |
| "reportTime": { |
| "description": "The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it's status reports so that clock skew does not play a factor.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "resources": { |
| "description": "Status for config resources", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ResourceStatus" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ReportInstanceStatusResponse": { |
| "description": "Placeholder for future enhancements to status reporting protocol", |
| "id": "GoogleCloudApigeeV1ReportInstanceStatusResponse", |
| "properties": {}, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ReportProperty": { |
| "id": "GoogleCloudApigeeV1ReportProperty", |
| "properties": { |
| "property": { |
| "description": "name of the property", |
| "type": "string" |
| }, |
| "value": { |
| "description": "property values", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Attribute" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ResourceConfig": { |
| "id": "GoogleCloudApigeeV1ResourceConfig", |
| "properties": { |
| "location": { |
| "description": "Location of the resource as a URI.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Resource name in the following format: `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` Only environment-scoped resource files are supported.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ResourceFile": { |
| "description": "Metadata about a resource file.", |
| "id": "GoogleCloudApigeeV1ResourceFile", |
| "properties": { |
| "name": { |
| "description": "ID of the resource file.", |
| "type": "string" |
| }, |
| "type": { |
| "description": "Resource file type. {{ resource_file_type }}", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ResourceFiles": { |
| "description": "List of resource files.", |
| "id": "GoogleCloudApigeeV1ResourceFiles", |
| "properties": { |
| "resourceFile": { |
| "description": "List of resource files.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1ResourceFile" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ResourceStatus": { |
| "description": "The status of a resource loaded in the runtime.", |
| "id": "GoogleCloudApigeeV1ResourceStatus", |
| "properties": { |
| "resource": { |
| "description": "The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig", |
| "type": "string" |
| }, |
| "revisions": { |
| "description": "Revisions of the resource currently deployed in the instance.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1RevisionStatus" |
| }, |
| "type": "array" |
| }, |
| "totalReplicas": { |
| "description": "The total number of replicas that should have this resource.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "uid": { |
| "description": "The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Result": { |
| "description": "Result is short for \"action result\", could be different types identified by \"action_result\" field. Supported types: 1. DebugInfo : generic debug info collected by runtime recorded as a list of properties. For example, the contents could be virtual host info, state change result, or execution metadata. Required fields : properties, timestamp 2. RequestMessage: information of a http request. Contains headers, request URI and http methods type.Required fields : headers, uri, verb 3. ResponseMessage: information of a http response. Contains headers, reason phrase and http status code. Required fields : headers, reasonPhrase, statusCode 4. ErrorMessage: information of a http error message. Contains detail error message, reason phrase and status code. Required fields : content, headers, reasonPhrase, statusCode 5. VariableAccess: a list of variable access actions, can be Get, Set and Remove. Required fields : accessList", |
| "id": "GoogleCloudApigeeV1Result", |
| "properties": { |
| "ActionResult": { |
| "description": "Type of the action result. Can be one of the five: DebugInfo, RequestMessage, ResponseMessage, ErrorMessage, VariableAccess", |
| "type": "string" |
| }, |
| "accessList": { |
| "description": "A list of variable access actions agaist the api proxy. Supported values: Get, Set, Remove.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Access" |
| }, |
| "type": "array" |
| }, |
| "content": { |
| "description": "Error message content. for example, \"content\" : \"{\\\"fault\\\":{\\\"faultstring\\\":\\\"API timed out\\\",\\\"detail\\\":{\\\"errorcode\\\":\\\"flow.APITimedOut\\\"}}}\"", |
| "type": "string" |
| }, |
| "headers": { |
| "description": "A list of HTTP headers. for example, '\"headers\" : [ { \"name\" : \"Content-Length\", \"value\" : \"83\" }, { \"name\" : \"Content-Type\", \"value\" : \"application/json\" } ]'", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Property" |
| }, |
| "type": "array" |
| }, |
| "properties": { |
| "$ref": "GoogleCloudApigeeV1Properties", |
| "description": "Name value pairs used for DebugInfo ActionResult." |
| }, |
| "reasonPhrase": { |
| "description": "HTTP response phrase", |
| "type": "string" |
| }, |
| "statusCode": { |
| "description": "HTTP response code", |
| "type": "string" |
| }, |
| "timestamp": { |
| "description": "Timestamp of when the result is recorded. Its format is dd-mm-yy hh:mm:ss:xxx. For example, `\"timestamp\" : \"12-08-19 00:31:59:960\"`", |
| "type": "string" |
| }, |
| "uRI": { |
| "description": "The relative path of the api proxy. for example, `\"uRI\" : \"/iloveapis\"`", |
| "type": "string" |
| }, |
| "verb": { |
| "description": "HTTP method verb", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1RevisionStatus": { |
| "description": "The status of a specific resource revision.", |
| "id": "GoogleCloudApigeeV1RevisionStatus", |
| "properties": { |
| "errors": { |
| "description": "Errors reported when attempting to load this revision.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1UpdateError" |
| }, |
| "type": "array" |
| }, |
| "jsonSpec": { |
| "description": "The json content of the resource revision.", |
| "type": "string" |
| }, |
| "replicas": { |
| "description": "The number of replicas that have successfully loaded this revision.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "revisionId": { |
| "description": "The revision of the resource.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1RoutingRule": { |
| "id": "GoogleCloudApigeeV1RoutingRule", |
| "properties": { |
| "basepath": { |
| "description": "URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string.", |
| "type": "string" |
| }, |
| "environment": { |
| "description": "Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Schema": { |
| "description": "Response for Schema call", |
| "id": "GoogleCloudApigeeV1Schema", |
| "properties": { |
| "dimensions": { |
| "description": "List of schema fiels grouped as dimensions.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1SchemaSchemaElement" |
| }, |
| "type": "array" |
| }, |
| "meta": { |
| "description": "Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "metrics": { |
| "description": "List of schema fields grouped as dimensions. These are fields that can be used with an aggregate function such as sum, avg, min, max.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1SchemaSchemaElement" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1SchemaSchemaElement": { |
| "description": "Message type for the schema element", |
| "id": "GoogleCloudApigeeV1SchemaSchemaElement", |
| "properties": { |
| "name": { |
| "description": "Name of the field", |
| "type": "string" |
| }, |
| "properties": { |
| "$ref": "GoogleCloudApigeeV1SchemaSchemaProperty", |
| "description": "Property of the schema field E.g. { \"createTime\": \"2016-02-26T10:23:09.592Z\", \"custom\": \"false\", \"type\": \"string\" }" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1SchemaSchemaProperty": { |
| "description": "Message type for schema property", |
| "id": "GoogleCloudApigeeV1SchemaSchemaProperty", |
| "properties": { |
| "createTime": { |
| "description": "Creation time of the field", |
| "type": "string" |
| }, |
| "custom": { |
| "description": "Custom is a flag signifying if the field was provided as part of the standard dataset or a custom field created by the customer", |
| "type": "string" |
| }, |
| "type": { |
| "description": "Data type of the field.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1ServiceIssuersMapping": { |
| "id": "GoogleCloudApigeeV1ServiceIssuersMapping", |
| "properties": { |
| "emailIds": { |
| "description": "List of trusted issuer email ids.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "service": { |
| "description": "String indicating the Apigee service name.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Session": { |
| "description": "Session carries the debug session id and its creation time.", |
| "id": "GoogleCloudApigeeV1Session", |
| "properties": { |
| "id": { |
| "description": "The debug session ID.", |
| "type": "string" |
| }, |
| "timestampMs": { |
| "description": "The first transaction creation timestamp in millisecond, recoreded by UAP.", |
| "format": "int64", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1SharedFlow": { |
| "description": "The metadata describing a shared flow", |
| "id": "GoogleCloudApigeeV1SharedFlow", |
| "properties": { |
| "latestRevisionId": { |
| "description": "The id of the most recently created revision for this shared flow.", |
| "type": "string" |
| }, |
| "metaData": { |
| "$ref": "GoogleCloudApigeeV1EntityMetadata", |
| "description": "Metadata describing the shared flow." |
| }, |
| "name": { |
| "description": "The ID of the shared flow.", |
| "type": "string" |
| }, |
| "revision": { |
| "description": "A list of revisions of this shared flow.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1SharedFlowRevision": { |
| "description": "The metadata describing a shared flow revision.", |
| "id": "GoogleCloudApigeeV1SharedFlowRevision", |
| "properties": { |
| "configurationVersion": { |
| "$ref": "GoogleCloudApigeeV1ConfigVersion", |
| "description": "The version of the configuration schema to which this shared flow conforms. The only supported value currently is majorVersion 4 and minorVersion 0. This setting may be used in the future to enable evolution of the shared flow format." |
| }, |
| "contextInfo": { |
| "description": "A textual description of the shared flow revision.", |
| "type": "string" |
| }, |
| "createdAt": { |
| "description": "Time at which this shared flow revision was created, in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "description": { |
| "description": "Description of the shared flow revision.", |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "The human readable name of this shared flow.", |
| "type": "string" |
| }, |
| "entityMetaDataAsProperties": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "A Key-Value map of metadata about this shared flow revision.", |
| "type": "object" |
| }, |
| "lastModifiedAt": { |
| "description": "Time at which this shared flow revision was most recently modified, in milliseconds since epoch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The resource ID of the parent shared flow.", |
| "type": "string" |
| }, |
| "policies": { |
| "description": "A list of policy names included in this shared flow revision.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "resourceFiles": { |
| "$ref": "GoogleCloudApigeeV1ResourceFiles", |
| "description": "The resource files included in this shared flow revision." |
| }, |
| "resources": { |
| "description": "A list of the resources included in this shared flow revision formatted as \"{type}://{name}\".", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "revision": { |
| "description": "The resource ID of this revision.", |
| "type": "string" |
| }, |
| "sharedFlows": { |
| "description": "A list of the shared flow names included in this shared flow revision.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "type": { |
| "description": "The string \"Application\"", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Stats": { |
| "description": "This message type encapsulates a stats response.", |
| "id": "GoogleCloudApigeeV1Stats", |
| "properties": { |
| "environments": { |
| "description": "This field contains a list of query results on environment level.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1StatsEnvironmentStats" |
| }, |
| "type": "array" |
| }, |
| "metaData": { |
| "$ref": "GoogleCloudApigeeV1Metadata", |
| "description": "This field contains the metadata information." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1StatsEnvironmentStats": { |
| "description": "This message type encapsulates the environment wrapper: \"environments\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.52056245E8\" ] } ], \"name\": \"prod\" } ]", |
| "id": "GoogleCloudApigeeV1StatsEnvironmentStats", |
| "properties": { |
| "dimensions": { |
| "description": "This field contains the list of metrics grouped under dimensions.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1DimensionMetric" |
| }, |
| "type": "array" |
| }, |
| "metrics": { |
| "description": "In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only a top level metrics is provided. If dimensions are included, then there will be a top level dimensions field under environments which will contain metrics values and the dimension name. Example: \"environments\": [ { \"dimensions\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.14049521E8\" ] } ], \"name\": \"nit_proxy\" } ], \"name\": \"prod\" } ] OR \"environments\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.19026331E8\" ] } ], \"name\": \"prod\" } ] This field contains the list of metric values.", |
| "items": { |
| "$ref": "GoogleCloudApigeeV1Metric" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1Subscription": { |
| "description": "Pub/Sub subscription of an environment.", |
| "id": "GoogleCloudApigeeV1Subscription", |
| "properties": { |
| "name": { |
| "description": "Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription \"projects/foo/subscription/bar\"`", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1SyncAuthorization": { |
| "id": "GoogleCloudApigeeV1SyncAuthorization", |
| "properties": { |
| "etag": { |
| "description": "Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions.", |
| "format": "byte", |
| "type": "string" |
| }, |
| "identities": { |
| "description": "Required. Array of service accounts to grant access to control plane resources, each specified using the following format: `serviceAccount:` service-account-name. The service-account-name is formatted like an email address. For example: `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service-accounts).", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1TargetServer": { |
| "description": "TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.", |
| "id": "GoogleCloudApigeeV1TargetServer", |
| "properties": { |
| "description": { |
| "description": "Optional. A human-readable description of this TargetServer.", |
| "type": "string" |
| }, |
| "host": { |
| "description": "Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.", |
| "type": "string" |
| }, |
| "isEnabled": { |
| "description": "Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.", |
| "type": "boolean" |
| }, |
| "name": { |
| "description": "Required. The resource id of this target server. Values must match the regular expression ", |
| "type": "string" |
| }, |
| "port": { |
| "description": "Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "sSLInfo": { |
| "$ref": "GoogleCloudApigeeV1TlsInfo", |
| "description": "Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1TargetServerConfig": { |
| "id": "GoogleCloudApigeeV1TargetServerConfig", |
| "properties": { |
| "host": { |
| "description": "Host name of the target server.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Target server revision name in the following format: `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}`", |
| "type": "string" |
| }, |
| "port": { |
| "description": "Port number for the target server.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "tlsInfo": { |
| "$ref": "GoogleCloudApigeeV1TlsInfoConfig", |
| "description": "TLS settings for the target server." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1TestDatastoreResponse": { |
| "description": "The response for TestDatastore", |
| "id": "GoogleCloudApigeeV1TestDatastoreResponse", |
| "properties": { |
| "error": { |
| "description": "Output only. Error message of test connection failure", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "state": { |
| "description": "Output only. It could be `completed` or `failed`", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1TlsInfo": { |
| "description": "TLS configuration information for VirtualHosts and TargetServers.", |
| "id": "GoogleCloudApigeeV1TlsInfo", |
| "properties": { |
| "ciphers": { |
| "description": "The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "clientAuthEnabled": { |
| "description": "Optional. Enables two-way TLS.", |
| "type": "boolean" |
| }, |
| "commonName": { |
| "$ref": "GoogleCloudApigeeV1TlsInfoCommonName", |
| "description": "The TLS Common Name of the certificate." |
| }, |
| "enabled": { |
| "description": "Required. Enables one-way TLS.", |
| "type": "boolean" |
| }, |
| "ignoreValidationErrors": { |
| "description": "If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.", |
| "type": "boolean" |
| }, |
| "keyAlias": { |
| "description": "Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.", |
| "type": "string" |
| }, |
| "keyStore": { |
| "description": "Required if `client_auth_enabled` is true. The resource ID of the keystore. References not yet supported.", |
| "type": "string" |
| }, |
| "protocols": { |
| "description": "The TLS versioins to be used.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "trustStore": { |
| "description": "The resource ID of the truststore. References not yet supported.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1TlsInfoCommonName": { |
| "id": "GoogleCloudApigeeV1TlsInfoCommonName", |
| "properties": { |
| "value": { |
| "description": "The TLS Common Name string of the certificate.", |
| "type": "string" |
| }, |
| "wildcardMatch": { |
| "description": "Indicates whether the cert should be matched against as a wildcard cert.", |
| "type": "boolean" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1TlsInfoConfig": { |
| "id": "GoogleCloudApigeeV1TlsInfoConfig", |
| "properties": { |
| "ciphers": { |
| "description": "List of ciphers that are granted access.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "clientAuthEnabled": { |
| "description": "Flag that specifies whether client-side authentication is enabled for the target server. Enables two-way TLS.", |
| "type": "boolean" |
| }, |
| "commonName": { |
| "$ref": "GoogleCloudApigeeV1CommonNameConfig", |
| "description": "Common name to validate the target server against." |
| }, |
| "enabled": { |
| "description": "Flag that specifies whether one-way TLS is enabled. Set to `true` to enable one-way TLS.", |
| "type": "boolean" |
| }, |
| "ignoreValidationErrors": { |
| "description": "Flag that specifies whether to ignore TLS certificate validation errors. Set to `true` to ignore errors.", |
| "type": "boolean" |
| }, |
| "keyAlias": { |
| "description": "Name of the alias used for client-side authentication in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`", |
| "type": "string" |
| }, |
| "keyAliasReference": { |
| "$ref": "GoogleCloudApigeeV1KeyAliasReference", |
| "description": "Reference name and alias pair to use for client-side authentication." |
| }, |
| "protocols": { |
| "description": "List of TLS protocols that are granted access.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "trustStore": { |
| "description": "Name of the keystore or keystore reference containing trusted certificates for the server in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` or `organizations/{org}/environments/{env}/references/{reference}`", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleCloudApigeeV1UpdateError": { |
| "description": "Details on why a resource update failed in the runtime.", |
| "id": "GoogleCloudApigeeV1UpdateError", |
| "properties": { |
| "code": { |
| "description": "Status code.", |
| "enum": [ |
| "OK", |
| "CANCELLED", |
| "UNKNOWN", |
| "INVALID_ARGUMENT", |
| "DEADLINE_EXCEEDED", |
| "NOT_FOUND", |
| "ALREADY_EXISTS", |
| "PERMISSION_DENIED", |
| "UNAUTHENTICATED", |
| "RESOURCE_EXHAUSTED", |
| "FAILED_PRECONDITION", |
| "ABORTED", |
| "OUT_OF_RANGE", |
| "UNIMPLEMENTED", |
| "INTERNAL", |
| "UNAVAILABLE", |
| "DATA_LOSS" |
| ], |
| "enumDescriptions": [ |
| "Not an error; returned on success HTTP Mapping: 200 OK", |
| "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", |
| "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", |
| "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", |
| "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", |
| "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", |
| "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", |
| "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", |
| "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", |
| "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", |
| "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", |
| "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", |
| "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", |
| "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", |
| "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", |
| "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", |
| "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" |
| ], |
| "type": "string" |
| }, |
| "message": { |
| "description": "User-friendly error message.", |
| "type": "string" |
| }, |
| "resource": { |
| "description": "The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource.", |
| "type": "string" |
| }, |
| "type": { |
| "description": "A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleIamV1AuditConfig": { |
| "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", |
| "id": "GoogleIamV1AuditConfig", |
| "properties": { |
| "auditLogConfigs": { |
| "description": "The configuration for logging of each type of permission.", |
| "items": { |
| "$ref": "GoogleIamV1AuditLogConfig" |
| }, |
| "type": "array" |
| }, |
| "service": { |
| "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleIamV1AuditLogConfig": { |
| "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", |
| "id": "GoogleIamV1AuditLogConfig", |
| "properties": { |
| "exemptedMembers": { |
| "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "logType": { |
| "description": "The log type that this config enables.", |
| "enum": [ |
| "LOG_TYPE_UNSPECIFIED", |
| "ADMIN_READ", |
| "DATA_WRITE", |
| "DATA_READ" |
| ], |
| "enumDescriptions": [ |
| "Default case. Should never be this.", |
| "Admin reads. Example: CloudIAM getIamPolicy", |
| "Data writes. Example: CloudSQL Users create", |
| "Data reads. Example: CloudSQL Users list" |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleIamV1Binding": { |
| "description": "Associates `members` with a `role`.", |
| "id": "GoogleIamV1Binding", |
| "properties": { |
| "condition": { |
| "$ref": "GoogleTypeExpr", |
| "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." |
| }, |
| "members": { |
| "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "role": { |
| "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleIamV1Policy": { |
| "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", |
| "id": "GoogleIamV1Policy", |
| "properties": { |
| "auditConfigs": { |
| "description": "Specifies cloud audit logging configuration for this policy.", |
| "items": { |
| "$ref": "GoogleIamV1AuditConfig" |
| }, |
| "type": "array" |
| }, |
| "bindings": { |
| "description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.", |
| "items": { |
| "$ref": "GoogleIamV1Binding" |
| }, |
| "type": "array" |
| }, |
| "etag": { |
| "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", |
| "format": "byte", |
| "type": "string" |
| }, |
| "version": { |
| "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", |
| "format": "int32", |
| "type": "integer" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleIamV1SetIamPolicyRequest": { |
| "description": "Request message for `SetIamPolicy` method.", |
| "id": "GoogleIamV1SetIamPolicyRequest", |
| "properties": { |
| "policy": { |
| "$ref": "GoogleIamV1Policy", |
| "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them." |
| }, |
| "updateMask": { |
| "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", |
| "format": "google-fieldmask", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleIamV1TestIamPermissionsRequest": { |
| "description": "Request message for `TestIamPermissions` method.", |
| "id": "GoogleIamV1TestIamPermissionsRequest", |
| "properties": { |
| "permissions": { |
| "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleIamV1TestIamPermissionsResponse": { |
| "description": "Response message for `TestIamPermissions` method.", |
| "id": "GoogleIamV1TestIamPermissionsResponse", |
| "properties": { |
| "permissions": { |
| "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleLongrunningListOperationsResponse": { |
| "description": "The response message for Operations.ListOperations.", |
| "id": "GoogleLongrunningListOperationsResponse", |
| "properties": { |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| }, |
| "operations": { |
| "description": "A list of operations that matches the specified filter in the request.", |
| "items": { |
| "$ref": "GoogleLongrunningOperation" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleLongrunningOperation": { |
| "description": "This resource represents a long-running operation that is the result of a network API call.", |
| "id": "GoogleLongrunningOperation", |
| "properties": { |
| "done": { |
| "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", |
| "type": "boolean" |
| }, |
| "error": { |
| "$ref": "GoogleRpcStatus", |
| "description": "The error result of the operation in case of failure or cancellation." |
| }, |
| "metadata": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", |
| "type": "object" |
| }, |
| "name": { |
| "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", |
| "type": "string" |
| }, |
| "response": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", |
| "type": "object" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleProtobufEmpty": { |
| "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", |
| "id": "GoogleProtobufEmpty", |
| "properties": {}, |
| "type": "object" |
| }, |
| "GoogleRpcPreconditionFailure": { |
| "description": "Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.", |
| "id": "GoogleRpcPreconditionFailure", |
| "properties": { |
| "violations": { |
| "description": "Describes all precondition violations.", |
| "items": { |
| "$ref": "GoogleRpcPreconditionFailureViolation" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleRpcPreconditionFailureViolation": { |
| "description": "A message type used to describe a single precondition failure.", |
| "id": "GoogleRpcPreconditionFailureViolation", |
| "properties": { |
| "description": { |
| "description": "A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: \"Terms of service not accepted\".", |
| "type": "string" |
| }, |
| "subject": { |
| "description": "The subject, relative to the type, that failed. For example, \"google.com/cloud\" relative to the \"TOS\" type would indicate which terms of service is being referenced.", |
| "type": "string" |
| }, |
| "type": { |
| "description": "The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, \"TOS\" for \"Terms of Service violation\".", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleRpcStatus": { |
| "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", |
| "id": "GoogleRpcStatus", |
| "properties": { |
| "code": { |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "details": { |
| "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", |
| "items": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "type": "array" |
| }, |
| "message": { |
| "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleTypeExpr": { |
| "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' \u0026\u0026 document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", |
| "id": "GoogleTypeExpr", |
| "properties": { |
| "description": { |
| "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", |
| "type": "string" |
| }, |
| "expression": { |
| "description": "Textual representation of an expression in Common Expression Language syntax.", |
| "type": "string" |
| }, |
| "location": { |
| "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", |
| "type": "string" |
| }, |
| "title": { |
| "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| } |
| }, |
| "servicePath": "", |
| "title": "Apigee API", |
| "version": "v1", |
| "version_module": true |
| } |
