View Source API Reference google_api_apigee v0.46.0

API client metadata for GoogleApi.Apigee.V1.

API calls for all endpoints tagged Hybrid.

API calls for all endpoints tagged Organizations.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Apigee.V1.

Describes why a bundle is invalid. Intended for use in error details.

A message type used to describe a single bundle validation error.

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.

APIProductAssociation has the API product and its administrative state association.

Attributes

• Get (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AccessGet.t, default: nil) -
• Remove (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AccessRemove.t, default: nil) -
• Set (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AccessSet.t, default: nil) -

Get action. For example, "Get" : { "name" : "target.name", "value" : "default" }

Access logging configuration enables customers to ship the access logs from the tenant projects to their own project's cloud logging. The feature is at the instance level ad disabled by default. It can be enabled during CreateInstance or UpdateInstance.

Remove action. For example, "Remove" : { "name" : "target.name", "success" : true }

Set action. For example, "Set" : { "name" : "target.name", "success" : true, "value" : "default" }

Request for ActivateNatAddressRequest. Activate the nat address request.

Add-on configurations for the Apigee organization.

Request for AdjustDeveloperBalance.

Configuration for the Advanced API Ops add-on.

Reference to a certificate or key/certificate pair.

Attributes

• location (type: String.t, default: nil) - Location of the alias file. For example, a Google Cloud Storage URI.
• name (type: String.t, default: nil) - Name of the alias revision included in the keystore in the following format: organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}
• type (type: String.t, default: nil) -

Configuration for the Analytics add-on.

ApiCategory represents an API category. Catalog items can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category.

The API category resource wrapped with response status, error_code, etc.

ApiDoc represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The api_product_name field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.

The documentation for a catalog item.

The catalog item documentation wrapped with response status, error_code, etc.

The catalog item resource wrapped with response status, error_code, etc.

Attributes

• apiResources (type: list(String.t), default: nil) - 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 Managing API products.
• approvalType (type: String.t, default: nil) - Flag that 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.
• attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - 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.
• createdAt (type: String.t, default: nil) - Response only. Creation time of this environment as milliseconds since epoch.
• description (type: String.t, default: nil) - Description of the API product. Include key information about the API product that is not captured by other fields.
• displayName (type: String.t, default: nil) - Name displayed in the UI or developer portal to developers registering for API access.
• environments (type: list(String.t), default: nil) - 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.
• graphqlOperationGroup (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GraphQLOperationGroup.t, default: nil) - Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.
• grpcOperationGroup (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GrpcOperationGroup.t, default: nil) - Optional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service.
• lastModifiedAt (type: String.t, default: nil) - Response only. Modified time of this environment as milliseconds since epoch.
• name (type: String.t, default: nil) - 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.
• operationGroup (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OperationGroup.t, default: nil) - Configuration used 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, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the quota setting). Note: The api_resources setting cannot be specified for both the API product and operation group; otherwise the call will fail.
• proxies (type: list(String.t), default: nil) - 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. Apigee 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.
• quota (type: String.t, default: nil) - 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.
• quotaCounterScope (type: String.t, default: nil) - Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
• quotaInterval (type: String.t, default: nil) - Time interval over which the number of request messages is calculated.
• quotaTimeUnit (type: String.t, default: nil) - Time unit defined for the quotaInterval. Valid values include minute, hour, day, or month.
• scopes (type: list(String.t), default: nil) - Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.

Attributes

• apiproduct (type: String.t, default: nil) - Name of the API product.
• status (type: String.t, default: nil) - Status of the API product. Valid values are approved or revoked.

Metadata describing the API proxy

API proxy revision.

Configurations of the API Security add-on.

Response for GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig].

Attributes

• apiProducts (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProductRef.t), default: nil) - List of API products associated with the app.
• appGroup (type: String.t, default: nil) - Name of the AppGroup
• appId (type: String.t, default: nil) - ID of the app.
• attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes.
• callbackUrl (type: String.t, default: nil) - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.
• companyName (type: String.t, default: nil) - Name of the company that owns the app.
• createdAt (type: String.t, default: nil) - Output only. Unix time when the app was created.
• credentials (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Credential.t), default: nil) - Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.
• developerEmail (type: String.t, default: nil) - Email of the developer.
• developerId (type: String.t, default: nil) - ID of the developer.
• keyExpiresIn (type: String.t, default: nil) - 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
• lastModifiedAt (type: String.t, default: nil) - Output only. Last modified time as milliseconds since epoch.
• name (type: String.t, default: nil) - Name of the app.
• scopes (type: list(String.t), default: nil) - Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.
• status (type: String.t, default: nil) - Status of the credential.

AppGroup contains the request/response fields representing the logical grouping of apps. Note that appgroup_id, create_time and update_time cannot be changed by the user, and gets updated by the system. The name and the organization once provided cannot be edited subsequently.

Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp]

AppGroupAppKey contains all the information associated with the credentials.

Archive Deployment information.

Attributes

• created (type: String.t, default: nil) - Creation time of the query.
• envgroupHostname (type: String.t, default: nil) - Hostname is available only when query is executed at host level.
• error (type: String.t, default: nil) - Error is set when query fails.
• executionTime (type: String.t, default: nil) - ExecutionTime is available only after the query is completed.
• name (type: String.t, default: nil) - Asynchronous Query Name.
• queryParams (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1QueryMetadata.t, default: nil) - Contains information like metrics, dimenstions etc of the AsyncQuery.
• reportDefinitionId (type: String.t, default: nil) - Asynchronous Report ID.
• result (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AsyncQueryResult.t, default: nil) - Result is available only after the query is completed.
• resultFileSize (type: String.t, default: nil) - ResultFileSize is available only after the query is completed.
• resultRows (type: String.t, default: nil) - ResultRows is available only after the query is completed.
• self (type: String.t, default: nil) - Self link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
• state (type: String.t, default: nil) - Query state could be "enqueued", "running", "completed", "failed".
• updated (type: String.t, default: nil) - Last updated timestamp for the query.

Attributes

• expires (type: String.t, default: nil) - Query result will be unaccessable after this time.
• self (type: String.t, default: nil) - Self link of the query results. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result

Attributes

• code (type: integer(), default: nil) - Error code when there is a failure.
• error (type: String.t, default: nil) - Error message when there is a failure.
• metadata (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1QueryMetadata.t, default: nil) - Metadata contains information like metrics, dimenstions etc of the AsyncQuery.
• rows (type: list(any()), default: nil) - Rows of query result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…}
• state (type: String.t, default: nil) - State of retrieving ResultView.

Key-value pair to store extra metadata.

Attributes

• attribute (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes.

Request for BatchUpdateSecurityIncident.

Response for BatchUpdateSecurityIncident.

CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests.

Labels that can be used to filter Apigee metrics.

X.509 certificate as defined in RFC 5280.

Attributes

• certInfo (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CertInfo.t), default: nil) - Chain of certificates under this name.

Attributes

• matchWildCards (type: boolean(), default: nil) -
• name (type: String.t, default: nil) -

Request for ComputeEnvironmentScores.

Filter scores by component path. Used custom filter instead of AIP-160 as the use cases are highly constrained and predictable.

Response for ComputeEnvironmentScores.

Version of the API proxy configuration schema. Currently, only 4.0 is supported.

Configuration for the Connectors Platform add-on.

Attributes

• apiProducts (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProductRef.t), default: nil) - List of API products this credential can be used for.
• attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes associated with this credential.
• consumerKey (type: String.t, default: nil) - Consumer key.
• consumerSecret (type: String.t, default: nil) - Secret key.
• expiresAt (type: String.t, default: nil) - Time the credential will expire in milliseconds since epoch.
• issuedAt (type: String.t, default: nil) - Time the credential was issued in milliseconds since epoch.
• scopes (type: list(String.t), default: nil) - List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
• status (type: String.t, default: nil) - Status of the credential. Valid values include approved or revoked.

Request for CreditDeveloperBalance.

Attributes

• chartType (type: String.t, default: nil) - This field contains the chart type for the report
• comments (type: list(String.t), default: nil) - Legacy field: not used. This field contains a list of comments associated with custom report
• createdAt (type: String.t, default: nil) - Output only. Unix time when the app was created json key: createdAt
• dimensions (type: list(String.t), default: nil) - This contains the list of dimensions for the report
• displayName (type: String.t, default: nil) - This is the display name for the report
• environment (type: String.t, default: nil) - Output only. Environment name
• filter (type: String.t, default: nil) - This field contains the filter expression
• fromTime (type: String.t, default: nil) - Legacy field: not used. Contains the from time for the report
• lastModifiedAt (type: String.t, default: nil) - Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
• lastViewedAt (type: String.t, default: nil) - Output only. Last viewed time of this entity as milliseconds since epoch
• limit (type: String.t, default: nil) - Legacy field: not used This field contains the limit for the result retrieved
• metrics (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReportMetric.t), default: nil) - Required. This contains the list of metrics
• name (type: String.t, default: nil) - Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
• offset (type: String.t, default: nil) - Legacy field: not used. This field contains the offset for the data
• organization (type: String.t, default: nil) - Output only. Organization name
• properties (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ReportProperty.t), default: nil) - This field contains report properties such as ui metadata etc.
• sortByCols (type: list(String.t), default: nil) - Legacy field: not used much. Contains the list of sort by columns
• sortOrder (type: String.t, default: nil) - Legacy field: not used much. Contains the sort order for the sort columns
• tags (type: list(String.t), default: nil) - Legacy field: not used. This field contains a list of tags associated with custom report
• timeUnit (type: String.t, default: nil) - This field contains the time unit of aggregation for the report
• toTime (type: String.t, default: nil) - Legacy field: not used. Contains the end time for the report
• topk (type: String.t, default: nil) - Legacy field: not used. This field contains the top k parameter value for restricting the result

This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum

Data collector configuration.

Data collector and its configuration.

The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.

Configuration detail for datastore

Date range of the data to export.

Attributes

• faultJSONPaths (type: list(String.t), default: nil) - List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
• faultXPaths (type: list(String.t), default: nil) - List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
• name (type: String.t, default: nil) - Name of the debug mask.
• namespaces (type: map(), default: nil) - Map of namespaces to URIs.
• requestJSONPaths (type: list(String.t), default: nil) - List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
• requestXPaths (type: list(String.t), default: nil) - List of XPaths that specify the XML elements to be filtered from XML request message payloads.
• responseJSONPaths (type: list(String.t), default: nil) - List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
• responseXPaths (type: list(String.t), default: nil) - List of XPaths that specify the XML elements to be filtered from XML response message payloads.
• variables (type: list(String.t), default: nil) - List of variables that should be masked from the debug output.

Attributes

• count (type: integer(), default: nil) - Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
• createTime (type: DateTime.t, default: nil) - Output only. The first transaction creation timestamp, recorded by UAP.
• filter (type: String.t, default: nil) - 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.
• name (type: String.t, default: nil) - A unique ID for this DebugSession.
• timeout (type: String.t, default: nil) - Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
• tracesize (type: integer(), default: nil) - Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
• validity (type: integer(), default: nil) - 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.

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.

Attributes

• message (type: String.t, default: nil) - The response contains only a message field.

Response for certain delete operations.

Attributes

• apiProxy (type: String.t, default: nil) - API proxy.
• deployStartTime (type: String.t, default: nil) - Time the API proxy was marked deployed in the control plane in millisconds since epoch.
• environment (type: String.t, default: nil) - Environment.
• errors (type: list(GoogleApi.Apigee.V1.Model.GoogleRpcStatus.t), default: nil) - Errors reported for this deployment. Populated only when state == ERROR. Note: This field is displayed only when viewing deployment status.
• instances (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1InstanceDeploymentStatus.t), default: nil) - Status reported by each runtime instance. Note: This field is displayed only when viewing deployment status.
• pods (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PodStatus.t), default: nil) - Status reported by runtime pods. Note: This field is deprecated. Runtime versions 1.3 and above report instance level status rather than pod status.
• proxyDeploymentType (type: String.t, default: nil) - Output only. The type of the deployment (standard or extensible) Deployed proxy revision will be marked as extensible in following 2 cases. 1. The deployed proxy revision uses extensible policies. 2. If a environment supports flowhooks and flow hook is configured.
• revision (type: String.t, default: nil) - API proxy revision.
• routeConflicts (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict.t), default: nil) - 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 deployment's base paths 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. Note: This field is displayed only when viewing deployment status.
• serviceAccount (type: String.t, default: nil) - The full resource name of Cloud IAM Service Account that this deployment is using, eg, projects/-/serviceAccounts/{email}.
• state (type: String.t, default: nil) - Current state of the deployment. Note: This field is displayed only when viewing deployment status.

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 base path in the proxy will not receive traffic due to an existing deployment having already claimed that base path. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected.

Describes a potential routing change that may occur as a result of some deployment operation.

Describes a routing conflict that may cause a deployment not to receive traffic at some base path.

Tuple representing a base path and the deployment containing it.

NEXT ID: 11

DeploymentGroupConfig represents a deployment group that should be present in a particular environment.

Attributes

• accessType (type: String.t, default: nil) - Access type.
• appFamily (type: String.t, default: nil) - Developer app family.
• apps (type: list(String.t), default: nil) - List of apps associated with the developer.
• attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - Optional. Developer attributes (name/value pairs). The custom attribute limit is 18.
• companies (type: list(String.t), default: nil) - List of companies associated with the developer.
• createdAt (type: String.t, default: nil) - Output only. Time at which the developer was created in milliseconds since epoch.
• developerId (type: String.t, default: nil) - ID of the developer. Note: IDs are generated internally by Apigee and are not guaranteed to stay the same over time.
• email (type: String.t, default: nil) - Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
• firstName (type: String.t, default: nil) - Required. First name of the developer.
• lastModifiedAt (type: String.t, default: nil) - Output only. Time at which the developer was last modified in milliseconds since epoch.
• lastName (type: String.t, default: nil) - Required. Last name of the developer.
• organizationName (type: String.t, default: nil) - Output only. Name of the Apigee organization in which the developer resides.
• status (type: String.t, default: nil) - Output only. Status of the developer. Valid values are active and inactive.
• userName (type: String.t, default: nil) - Required. User name of the developer. Not used by Apigee hybrid.

Attributes

• apiProducts (type: list(String.t), default: nil) - List of API products associated with the developer app.
• appFamily (type: String.t, default: nil) - Developer app family.
• appId (type: String.t, default: nil) - ID of the developer app.
• attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes for the developer app.
• callbackUrl (type: String.t, default: nil) - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
• createdAt (type: String.t, default: nil) - Output only. Time the developer app was created in milliseconds since epoch.
• credentials (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Credential.t), default: nil) - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.
• developerId (type: String.t, default: nil) - ID of the developer.
• keyExpiresIn (type: String.t, default: nil) - 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.
• lastModifiedAt (type: String.t, default: nil) - Output only. Time the developer app was modified in milliseconds since epoch.
• name (type: String.t, default: nil) - Name of the developer app.
• scopes (type: list(String.t), default: nil) - Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
• status (type: String.t, default: nil) - Status of the credential. Valid values include approved or revoked.

Attributes

• apiProducts (type: list(any()), default: nil) - 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.
• attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes associated with the credential.
• consumerKey (type: String.t, default: nil) - Consumer key.
• consumerSecret (type: String.t, default: nil) - Secret key.
• expiresAt (type: String.t, default: nil) - Time the developer app expires in milliseconds since epoch.
• expiresInSeconds (type: String.t, default: nil) - Input only. Expiration time, in seconds, for the consumer key. 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.
• issuedAt (type: String.t, default: nil) - Time the developer app was created in milliseconds since epoch.
• scopes (type: list(String.t), default: nil) - Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
• status (type: String.t, default: nil) - Status of the credential. Valid values include approved or revoked.

Account balance for the developer.

Wallet used to manage an account balance for a particular currency.

Monetization configuration for the developer.

Structure of a DeveloperSubscription.

Encapsulates a metric grouped by dimension.

Message to disable an enabled SecurityAction.

Documentation file contents for a catalog item.

Message to enable a disabled SecurityAction.

Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints).

EndpointChainingRule specifies the proxies contained in a particular deployment group, so that other deployment groups can find them in chaining calls.

Metadata common to many entities in this API.

Attributes

• apiProxyType (type: String.t, default: nil) - Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
• createdAt (type: String.t, default: nil) - Output only. Creation time of this environment as milliseconds since epoch.
• deploymentType (type: String.t, default: nil) - Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
• description (type: String.t, default: nil) - Optional. Description of the environment.
• displayName (type: String.t, default: nil) - Optional. Display name for this environment.
• forwardProxyUri (type: String.t, default: nil) - Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request.
• hasAttachedFlowHooks (type: boolean(), default: nil) -
• lastModifiedAt (type: String.t, default: nil) - Output only. Last modification time of this environment as milliseconds since epoch.
• name (type: String.t, default: nil) - Required. Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
• nodeConfig (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1NodeConfig.t, default: nil) - Optional. NodeConfig of the environment.
• properties (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Properties.t, default: nil) - Optional. Key-value pairs that may be used for customizing the environment.
• state (type: String.t, default: nil) - Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
• type (type: String.t, default: nil) - Optional. EnvironmentType selected for the environment.

Attributes

• addonsConfig (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RuntimeAddonsConfig.t, default: nil) - The latest runtime configurations for add-ons.
• arcConfigLocation (type: String.t, default: nil) - The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways.
• createTime (type: DateTime.t, default: nil) - Time that the environment configuration was created.
• dataCollectors (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DataCollectorConfig.t), default: nil) - List of data collectors used by the deployments in the environment.
• debugMask (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugMask.t, default: nil) - Debug mask that applies to all deployments in the environment.
• deploymentGroups (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeploymentGroupConfig.t), default: nil) - List of deployment groups in the environment.
• deployments (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeploymentConfig.t), default: nil) - List of deployments in the environment.
• envScopedRevisionId (type: String.t, default: nil) - Revision ID for environment-scoped resources (e.g. target servers, keystores) in this config. This ID will increment any time a resource not scoped to a deployment group changes.
• featureFlags (type: map(), default: nil) - Feature flags inherited from the organization and environment.
• flowhooks (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1FlowHookConfig.t), default: nil) - List of flow hooks in the environment.
• forwardProxyUri (type: String.t, default: nil) - The forward proxy's url to be used by the runtime. When set, runtime will send requests to the target via the given forward proxy. This is only used by programmable gateways.
• gatewayConfigLocation (type: String.t, default: nil) - The location for the gateway config blob as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways.
• keystores (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeystoreConfig.t), default: nil) - List of keystores in the environment.
• name (type: String.t, default: nil) - Name of the environment configuration in the following format: organizations/{org}/environments/{env}/configs/{config}
• provider (type: String.t, default: nil) - Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging.
• pubsubTopic (type: String.t, default: nil) - Name of the PubSub topic for the environment.
• resourceReferences (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ReferenceConfig.t), default: nil) - List of resource references in the environment.
• resources (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceConfig.t), default: nil) - List of resource versions in the environment.
• revisionId (type: String.t, default: nil) - Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed.
• sequenceNumber (type: String.t, default: nil) - DEPRECATED: Use revision_id.
• targets (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServerConfig.t), default: nil) - List of target servers in the environment. Disabled target servers are not displayed.
• traceConfig (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RuntimeTraceConfig.t, default: nil) - Trace configurations. Contains config for the environment and config overrides for specific API proxies.
• uid (type: String.t, default: nil) - Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated.

EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.

EnvironmentGroupAttachment is a resource which defines an attachment of an environment to an environment group.

EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.

Request for ExpireDeveloperSubscription.

Details of an export job.

Request body for [CreateExportRequest]

Attributes

• continueOnError (type: boolean(), default: nil) - 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.
• description (type: String.t, default: nil) - Description of the flow hook.
• flowHookPoint (type: String.t, default: nil) - Output only. Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
• sharedFlow (type: String.t, default: nil) - Shared flow attached to this flow hook, or empty if there is none attached.

Attributes

• continueOnError (type: boolean(), default: nil) - Flag that specifies whether the flow should abort after an error in the flow hook. Defaults to true (continue on error).
• name (type: String.t, default: nil) - Name of the flow hook in the following format: organizations/{org}/environments/{env}/flowhooks/{point}. Valid point values include: PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, and PostTargetFlowHook
• sharedFlowName (type: String.t, default: nil) - Name of the shared flow to invoke in the following format: organizations/{org}/sharedflows/{sharedflow}

Request for GenerateDownloadUrl method.

Response for GenerateDownloadUrl method.

Request for GenerateUploadUrl method.

Response for GenerateUploadUrl method.

The response for GetAsyncQueryResultUrl

A Signed URL and the relevant metadata associated with it.

Request for GetSyncAuthorization.

Represents the pairing of GraphQL operation types and the GraphQL operation name.

Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.

List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy.

GraphQL documentation for a catalog item.

Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.

List of gRPC operation configuration details associated with Apigee API proxies.

Attributes

• environmentGroups (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EnvironmentGroupConfig.t), default: nil) - List of environment groups in the organization.
• name (type: String.t, default: nil) - Name of the resource in the following format: organizations/{org}/deployedIngressConfig.
• revisionCreateTime (type: DateTime.t, default: nil) - Time at which the IngressConfig revision was created.
• revisionId (type: String.t, default: nil) - Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed.
• uid (type: String.t, default: nil) - A unique id for the ingress config that will only change if the organization is deleted and recreated.

Apigee runtime instance.

InstanceAttachment represents the installation of an environment onto an instance.

The status of a deployment as reported by a single instance.

Revisions deployed in the MPs.

Route deployed in the ingress routing table.

Configuration for the Integration add-on.

Attributes

• aliasId (type: String.t, default: nil) - Alias ID. Must exist in the keystore referred to by the reference.
• reference (type: String.t, default: nil) - Reference name in the following format: organizations/{org}/environments/{env}/references/{reference}

Key value map pair where the value represents the data associated with the corresponding key. Note: Supported for Apigee hybrid 1.8.x and higher.

Collection of key/value string pairs.

Datastore for Certificates and Aliases.

Attributes

• aliases (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AliasRevisionConfig.t), default: nil) - Aliases in the keystore.
• name (type: String.t, default: nil) - Resource name in the following format: organizations/{org}/environments/{env}/keystores/{keystore}

The response for ListApiCategoriesRequest. Next ID: 6

Attributes

• data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc.t), default: nil) - The catalog item resources.
• errorCode (type: String.t, default: nil) - Unique error code for the request, if any.
• message (type: String.t, default: nil) - Description of the operation.
• nextPageToken (type: String.t, default: nil) - A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
• requestId (type: String.t, default: nil) - Unique ID of the request.
• status (type: String.t, default: nil) - Status of the operation.

Attributes

• apiProduct (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t), default: nil) - Lists all API product names defined for an organization.

To change this message, in the same CL add a change log in go/changing-api-proto-breaks-ui

Response for ListAppGroupApps

ListAppGroupsResponse contains the 0 or more AppGroups, along with the optional page token and the total count of apps.

Attributes

• app (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1App.t), default: nil) -
• nextPageToken (type: String.t, default: nil) - Token that can be sent as next_page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
• totalSize (type: integer(), default: nil) - Total count of Apps.

Response for ListArchiveDeployments method.

The response for ListAsyncQueries.

This message encapsulates a list of custom report definitions

Response for ListDataCollectors.

The response for ListDatastores

Attributes

• nextPageToken (type: String.t, default: nil) - Page token that you can include in a ListDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist.
• sessions (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Session.t), default: nil) - Session info that includes debug session ID and the first transaction creation timestamp.

Attributes

• deployments (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Deployment.t), default: nil) - List of deployments.

Attributes

• app (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t), default: nil) - List of developer apps and their credentials.

Response for ListDeveloperSubscriptions.

Response for ListEndpointAttachments method.

Response for ListEnvironmentGroupAttachments.

Response for ListEnvironmentGroups.

Response for ListEnvironmentResources

The response for ListExports

Attributes

• issuers (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ServiceIssuersMapping.t), default: nil) - Lists of hybrid services and its trusted issuer email ids.

Response for ListInstanceAttachments.

Response for ListInstances.

The request structure for listing key value map keys and its corresponding values.

Response for ListNatAddresses.

Attributes

• developer (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer.t), default: nil) - List of developers.

Attributes

• organizations (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OrganizationProjectMapping.t), default: nil) - List of Apigee organizations and associated Google Cloud projects.

Response for ListRatePlans.

Contains a list of SecurityActions in response to a ListSecurityActionRequest.

Response for ListSecurityIncidents.

Response for ListSecurityProfileRevisions.

Response for ListSecurityProfiles.

The response for SecurityReports.

To change this message, in the same CL add a change log in go/changing-api-proto-breaks-ui

Response for ListTraceConfigOverrides.

Encapsulates additional information about query execution.

Encapsulates the metric data point. For example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }

The optionally aggregated metric to query with its ordering.

Configuration for the Monetization add-on.

Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic.

NodeConfig for setting the min/max number of nodes associated with the environment.

OpenAPI Specification documentation for a catalog item.

Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.

Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.

List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy.

Metadata describing an Operation.

Information about operation progress.

Attributes

• Response (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OptimizedStatsResponse.t, default: nil) - Wraps the stats response for JavaScript Optimized Scenario with a response key. For example: { "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 ] } ] } ] } } }

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.

Encapsulates a response format for JavaScript Optimized Scenario.

Attributes

• addonsConfig (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AddonsConfig.t, default: nil) - Addon configurations of the Apigee organization.
• analyticsRegion (type: String.t, default: nil) - Required. DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see Create an Apigee organization.
• apiConsumerDataEncryptionKeyName (type: String.t, default: nil) - Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType is EVALUATION or the region is not US/EU, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
• apiConsumerDataLocation (type: String.t, default: nil) - This field is needed only for customers with control plane in US or EU. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU.
• apigeeProjectId (type: String.t, default: nil) - Output only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee.
• attributes (type: list(String.t), default: nil) - Not used by Apigee.
• authorizedNetwork (type: String.t, default: nil) - Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API. Valid only when RuntimeType is set to CLOUD. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: default. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. To use a shared VPC network, use the following format: projects/{host-project-id}/{region}/networks/{network-name}. For example: projects/my-sharedvpc-host/global/networks/mynetwork Note: Not supported for Apigee hybrid.
• billingType (type: String.t, default: nil) - Billing type of the Apigee organization. See Apigee pricing.
• caCertificate (type: String.t, default: nil) - Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
• controlPlaneEncryptionKeyName (type: String.t, default: nil) - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
• createdAt (type: String.t, default: nil) - Output only. Time that the Apigee organization was created in milliseconds since epoch.
• customerName (type: String.t, default: nil) - Not used by Apigee.
• description (type: String.t, default: nil) - Description of the Apigee organization.
• disableVpcPeering (type: boolean(), default: nil) - Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.
• displayName (type: String.t, default: nil) - Display name for the Apigee organization. Unused, but reserved for future use.
• environments (type: list(String.t), default: nil) - Output only. List of environments in the Apigee organization.
• expiresAt (type: String.t, default: nil) - Output only. Time that the Apigee organization is scheduled for deletion.
• lastModifiedAt (type: String.t, default: nil) - Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
• name (type: String.t, default: nil) - Output only. Name of the Apigee organization.
• portalDisabled (type: boolean(), default: nil) - Configuration for the Portals settings.
• projectId (type: String.t, default: nil) - Output only. Project ID associated with the Apigee organization.
• properties (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Properties.t, default: nil) - Properties defined in the Apigee organization profile.
• runtimeDatabaseEncryptionKeyName (type: String.t, default: nil) - Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. Required when RuntimeType is CLOUD. If not specified when RuntimeType is TRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
• runtimeType (type: String.t, default: nil) - Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
• state (type: String.t, default: nil) - Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use.
• subscriptionPlan (type: String.t, default: nil) - Output only. Subscription plan that the customer has purchased. Output only.
• subscriptionType (type: String.t, default: nil) - Output only. DEPRECATED: This will eventually be replaced by BillingType. 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.
• type (type: String.t, default: nil) - Not used by Apigee.

Attributes

• location (type: String.t, default: nil) - Output only. The Google Cloud region where control plane data is located. For more information, see https://cloud.google.com/about/locations/.
• organization (type: String.t, default: nil) - Name of the Apigee organization.
• projectId (type: String.t, default: nil) - Google Cloud project associated with the Apigee organization
• projectIds (type: list(String.t), default: nil) - DEPRECATED: Use project_id. An Apigee Organization is mapped to a single project.

Attributes

• appVersion (type: String.t, default: nil) - Version of the application running in the pod.
• deploymentStatus (type: String.t, default: nil) - Status of the deployment. Valid values include: - deployed: Successful. - error : Failed. - pending : Pod has not yet reported on the deployment.
• deploymentStatusTime (type: String.t, default: nil) - Time the deployment status was reported in milliseconds since epoch.
• deploymentTime (type: String.t, default: nil) - Time the proxy was deployed in milliseconds since epoch.
• podName (type: String.t, default: nil) - Name of the pod which is reporting the status.
• podStatus (type: String.t, default: nil) - 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.
• podStatusTime (type: String.t, default: nil) - Time the pod status was reported in milliseconds since epoch.
• statusCode (type: String.t, default: nil) - Code associated with the deployment status.
• statusCodeDetails (type: String.t, default: nil) - Human-readable message associated with the status code.

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.

ProfileConfig defines a set of categories and policies which will be used to compute security score.

Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.

By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey

Checks to see if you have CORS policy in place.

Advanced API Security provides security profile that scores the following categories.

Checks to see if you have configured mTLS for the target server.

By default, following policies will be included: - OASValidation - SOAPMessageValidation

By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection

Message for compatibility with legacy Edge specification for Java Properties object in JSON.

A single property entry in the Properties message.

Request for ProvisionOrganization.

Attributes

• csvDelimiter (type: String.t, default: nil) - 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).
• dimensions (type: list(String.t), default: nil) - A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
• envgroupHostname (type: String.t, default: nil) - Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
• filter (type: String.t, default: nil) - 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
• groupByTimeUnit (type: String.t, default: nil) - 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.
• limit (type: integer(), default: nil) - Maximum number of rows that can be returned in the result.
• metrics (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1QueryMetric.t), default: nil) - A list of Metrics.
• name (type: String.t, default: nil) - Asynchronous Query Name.
• outputFormat (type: String.t, default: nil) - Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
• reportDefinitionId (type: String.t, default: nil) - Asynchronous Report ID.
• timeRange (type: any(), default: nil) - 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" }

Attributes

• dimensions (type: list(String.t), default: nil) - Dimensions of the AsyncQuery.
• endTimestamp (type: String.t, default: nil) - End timestamp of the query range.
• metrics (type: list(String.t), default: nil) - Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]
• outputFormat (type: String.t, default: nil) - Output format.
• startTimestamp (type: String.t, default: nil) - Start timestamp of the query range.
• timeUnit (type: String.t, default: nil) - Query GroupBy time unit.

More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics

Request payload representing the query to be run for fetching security statistics as rows.

Encapsulates two kinds of stats that are results of the dimensions and aggregations requested. - Tabular rows. - Time series data. Example of tabular rows, Represents security stats results as a row of flat values.

QueryTimeSeriesStatsRequest represents a query that returns a collection of time series sequences grouped by their values.

Represents security stats result as a collection of time series sequences.

A sequence of time series.

Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters.

Rate plan details.

API call volume range and the fees charged when the total number of API calls is within the range.

A Reference configuration. References must refer to a keystore that also exists in the parent environment.

Attributes

• name (type: String.t, default: nil) - Name of the reference in the following format: organizations/{org}/environments/{env}/references/{reference}
• resourceName (type: String.t, default: nil) - Name of the referenced resource in the following format: organizations/{org}/environments/{env}/keystores/{keystore} Only references to keystore resources are supported.

Request for ReportInstanceStatus.

Placeholder for future enhancements to status reporting protocol

Attributes

• property (type: String.t, default: nil) - name of the property
• value (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - property values

Attributes

• location (type: String.t, default: nil) - Location of the resource as a URI.
• name (type: String.t, default: nil) - Resource name in the following format: organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev} Only environment-scoped resource files are supported.

Metadata about a resource file.

List of resource files.

The status of a resource loaded in the runtime.

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

API call volume range and the percentage of revenue to share with the developer when the total number of API calls is within the range.

The status of a specific resource revision.

Attributes

• basepath (type: String.t, default: nil) - 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.
• deploymentGroup (type: String.t, default: nil) - Name of a deployment group in an environment bound to the environment group in the following format: organizations/{org}/environment/{env}/deploymentGroups/{group} Only one of environment or deployment_group will be set.
• envGroupRevision (type: String.t, default: nil) - The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.
• environment (type: String.t, default: nil) - Name of an environment bound to the environment group in the following format: organizations/{org}/environments/{env}. Only one of environment or deployment_group will be set.
• otherTargets (type: list(String.t), default: nil) - Conflicting targets, which will be resource names specifying either deployment groups or environments.
• receiver (type: String.t, default: nil) - The resource name of the proxy revision that is receiving this basepath in the following format: organizations/{org}/apis/{api}/revisions/{rev}. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.
• updateTime (type: DateTime.t, default: nil) - The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.

RuntimeAddonsConfig defines the runtime configurations for add-ons in an environment.

Runtime configuration for the Analytics add-on.

Runtime configuration for the API Security add-on.

Runtime configuration for the organization. Response for GetRuntimeConfig.

NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment.

NEXT ID: 7 Trace configuration override for a specific API proxy in an environment.

NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.

Response for Schema call

Message type for the schema element

Properties for the schema field.

Represents Security Score.

Component is an individual security element that is scored.

Recommendation based on security concerns and score.

Action to improve security score.

Action context are all the relevant details for the action.

A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction.

Message that should be set in case of an Allow Action. This does not have any fields.

The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed.

Message that should be set in case of a Deny Action.

The message that should be set in the case of a Flag action.

An HTTP header.

SecurityActionsConfig reflects the current state of the SecurityActions feature. This is a singleton resource: https://google.aip.dev/156

Represents an SecurityIncident resource.

Represents a SecurityProfile resource.

Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.

Represents a SecurityProfileEnvironmentAssociation resource.

Security configurations to manage scoring.

SecurityReport saves all the information about the created security report.

Metadata for the security report.

Body structure when user makes a request to create a security report.

Metric of the Query

Contains informations about the security report results.

The response for security report result view APIs.

SecuritySettings reflects the current state of the SecuritySettings feature.

Attributes

• emailIds (type: list(String.t), default: nil) - List of trusted issuer email ids.
• service (type: String.t, default: nil) - String indicating the Apigee service name.

Session carries the debug session id and its creation time.

Request for SetAddonEnablement.

Request for SetAddons.

The metadata describing a shared flow

The metadata describing a shared flow revision.

Encapsulates a stats response.

Encapsulates the environment wrapper: "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]

Encapsulates the hostname wrapper: "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "example.com" } ]

Pub/Sub subscription of an environment.

Attributes

• etag (type: String.t, default: nil) - 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 an ETag is returned in the response. Pass that ETag when calling the 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.
• identities (type: list(String.t), default: nil) - 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.

TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.

Attributes

• enabled (type: boolean(), default: nil) - Whether the target server is enabled. An empty/omitted value for this field should be interpreted as true.
• host (type: String.t, default: nil) - Host name of the target server.
• name (type: String.t, default: nil) - Target server revision name in the following format: organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}
• port (type: integer(), default: nil) - Port number for the target server.
• protocol (type: String.t, default: nil) - The protocol used by this target server.
• tlsInfo (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TlsInfoConfig.t, default: nil) - TLS settings for the target server.

The response for TestDatastore

TLS configuration information for virtual hosts and TargetServers.

Attributes

• value (type: String.t, default: nil) - The TLS Common Name string of the certificate.
• wildcardMatch (type: boolean(), default: nil) - Indicates whether the cert should be matched against as a wildcard cert.

Attributes

• ciphers (type: list(String.t), default: nil) - List of ciphers that are granted access.
• clientAuthEnabled (type: boolean(), default: nil) - Flag that specifies whether client-side authentication is enabled for the target server. Enables two-way TLS.
• commonName (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CommonNameConfig.t, default: nil) - Common name to validate the target server against.
• enabled (type: boolean(), default: nil) - Flag that specifies whether one-way TLS is enabled. Set to true to enable one-way TLS.
• ignoreValidationErrors (type: boolean(), default: nil) - Flag that specifies whether to ignore TLS certificate validation errors. Set to true to ignore errors.
• keyAlias (type: String.t, default: nil) - Name of the alias used for client-side authentication in the following format: organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}
• keyAliasReference (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyAliasReference.t, default: nil) - Reference name and alias pair to use for client-side authentication.
• protocols (type: list(String.t), default: nil) - List of TLS protocols that are granted access.
• trustStore (type: String.t, default: nil) - 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}

TraceConfig defines the configurations in an environment of distributed trace.

A representation of a configuration override.

TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.

Request for UpdateAppGroupAppKey

Details on why a resource update failed in the runtime.

Request for UpdateSecurityIncident.

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.

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.

Associates members, or principals, with a role.

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, or principals, to a single role. Principals 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. 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 < 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 < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.

Request message for SetIamPolicy method.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

The response message for Operations.ListOperations.

This resource represents a long-running operation that is the result of a network API call.

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); }

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.

A message type used to describe a single precondition failure.

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. 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.

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() < 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' && 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.

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

Represents an amount of money with its currency type.