Returns the addonsConfig Resource.
Returns the analytics Resource.
Returns the apis Resource.
Returns the archiveDeployments Resource.
Returns the caches Resource.
Returns the deployments Resource.
Returns the flowhooks Resource.
Returns the keystores Resource.
Returns the keyvaluemaps Resource.
Returns the optimizedStats Resource.
Returns the queries Resource.
Returns the references Resource.
Returns the resourcefiles Resource.
Returns the securityActions Resource.
Returns the securityIncidents Resource.
Returns the securityReports Resource.
Returns the securityStats Resource.
Returns the sharedflows Resource.
Returns the stats Resource.
Returns the targetservers Resource.
Returns the traceConfig Resource.
Close httplib2 connections.
create(parent, body=None, name=None, x__xgafv=None)
Creates an environment in an organization.
Deletes an environment from an organization. **Warning: You must delete all key value maps and key value entries before you delete an environment.** Otherwise, if you re-create the environment the key value map entry operations will encounter encryption/decryption discrepancies.
Gets environment details.
getAddonsConfig(name, x__xgafv=None)
Gets the add-ons config of an environment.
getApiSecurityRuntimeConfig(name, x__xgafv=None)
Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config.
getDebugmask(name, x__xgafv=None)
Gets the debug mask singleton resource for an environment.
getDeployedConfig(name, x__xgafv=None)
Gets the deployed configuration for an environment.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API.
getSecurityActionsConfig(name, x__xgafv=None)
GetSecurityActionConfig returns the current SecurityActions configuration.
getTraceConfig(name, x__xgafv=None)
Get distributed trace configuration in an environment.
modifyEnvironment(name, body=None, updateMask=None, x__xgafv=None)
Updates properties for an Apigee environment with patch semantics using a field mask. **Note:** Not supported for Apigee hybrid.
setIamPolicy(resource, body=None, x__xgafv=None)
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://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API.
subscribe(parent, x__xgafv=None)
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.
testIamPermissions(resource, body=None, x__xgafv=None)
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).
unsubscribe(parent, body=None, x__xgafv=None)
Deletes a subscription for the environment's Pub/Sub topic.
update(name, body=None, x__xgafv=None)
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). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment.
updateDebugmask(name, body=None, replaceRepeatedFields=None, updateMask=None, x__xgafv=None)
Updates the debug mask singleton resource for an environment.
updateEnvironment(name, body=None, x__xgafv=None)
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). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment.
updateSecurityActionsConfig(name, body=None, updateMask=None, x__xgafv=None)
UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level.
updateTraceConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.
close()
Close httplib2 connections.
create(parent, body=None, name=None, x__xgafv=None)
Creates an environment in an organization.
Args:
parent: string, Required. Name of the organization in which the environment will be created. Use the following structure in your request: `organizations/{org}` (required)
body: object, The request body.
The object takes the form of:
{
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"deploymentType": "A String", # 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](/apigee/docs/api-platform/local-development/overview#prevented-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": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"forwardProxyUri": "A String", # 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": True or False,
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"nodeConfig": { # NodeConfig for setting the min/max number of nodes associated with the environment. # Optional. NodeConfig of the environment.
"currentAggregateNodeCount": "A String", # Output only. The current total number of gateway nodes that each environment currently has across all instances.
"maxNodeCount": "A String", # Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
"minNodeCount": "A String", # Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
},
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
"type": "A String", # Optional. EnvironmentType selected for the environment.
}
name: string, Optional. Name of the environment.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, x__xgafv=None)
Deletes an environment from an organization. **Warning: You must delete all key value maps and key value entries before you delete an environment.** Otherwise, if you re-create the environment the key value map entry operations will encounter encryption/decryption discrepancies.
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets environment details.
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"deploymentType": "A String", # 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](/apigee/docs/api-platform/local-development/overview#prevented-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": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"forwardProxyUri": "A String", # 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": True or False,
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"nodeConfig": { # NodeConfig for setting the min/max number of nodes associated with the environment. # Optional. NodeConfig of the environment.
"currentAggregateNodeCount": "A String", # Output only. The current total number of gateway nodes that each environment currently has across all instances.
"maxNodeCount": "A String", # Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
"minNodeCount": "A String", # Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
},
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
"type": "A String", # Optional. EnvironmentType selected for the environment.
}
getAddonsConfig(name, x__xgafv=None)
Gets the add-ons config of an environment.
Args:
name: string, Required. Name of the add-ons config. Must be in the format of `/organizations/{org}/environments/{env}/addonsConfig` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Add-on configurations for the Apigee organization.
"advancedApiOpsConfig": { # Configuration for the Advanced API Ops add-on. # Configuration for the Advanced API Ops add-on.
"enabled": True or False, # Flag that specifies whether the Advanced API Ops add-on is enabled.
},
"analyticsConfig": { # Configuration for the Analytics add-on. # Configuration for the Analytics add-on. Only used in organizations.environments.addonsConfig.
"enabled": True or False, # Whether the Analytics add-on is enabled.
"expireTimeMillis": "A String", # Output only. Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
"state": "A String", # Output only. The state of the Analytics add-on.
"updateTime": "A String", # Output only. The latest update time.
},
"apiSecurityConfig": { # Configurations of the API Security add-on. # Configuration for the API Security add-on.
"enabled": True or False, # Flag that specifies whether the API security add-on is enabled.
"expiresAt": "A String", # Output only. Time at which the API Security add-on expires in in milliseconds since epoch. If unspecified, the add-on will never expire.
},
"connectorsPlatformConfig": { # Configuration for the Connectors Platform add-on. # Configuration for the Connectors Platform add-on.
"enabled": True or False, # Flag that specifies whether the Connectors Platform add-on is enabled.
"expiresAt": "A String", # Output only. Time at which the Connectors Platform add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
},
"integrationConfig": { # Configuration for the Integration add-on. # Configuration for the Integration add-on.
"enabled": True or False, # Flag that specifies whether the Integration add-on is enabled.
},
"monetizationConfig": { # Configuration for the Monetization add-on. # Configuration for the Monetization add-on.
"enabled": True or False, # Flag that specifies whether the Monetization add-on is enabled.
},
}
getApiSecurityRuntimeConfig(name, x__xgafv=None)
Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config.
Args:
name: string, Required. Name of the environment API Security Runtime configuration resource. Use the following structure in your request: `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig].
"location": [ # A list of up to 5 Cloud Storage Blobs that contain SecurityActions.
"A String",
],
"name": "A String", # Name of the environment API Security Runtime configuration resource. Format: `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig`
"revisionId": "A String", # Revision ID of the API Security Runtime configuration. The higher the value, the more recently the configuration was deployed.
"uid": "A String", # Unique ID for the API Security Runtime configuration. The ID will only change if the environment is deleted and recreated.
"updateTime": "A String", # Time that the API Security Runtime configuration was updated.
}
getDebugmask(name, x__xgafv=None)
Gets the debug mask singleton resource for an environment.
Args:
name: string, Required. Name of the debug mask. Use the following structure in your request: `organizations/{org}/environments/{env}/debugmask`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
"A String",
],
"faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
"A String",
],
"name": "A String", # Name of the debug mask.
"namespaces": { # Map of namespaces to URIs.
"a_key": "A String",
},
"requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
"A String",
],
"requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads.
"A String",
],
"responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
"A String",
],
"responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads.
"A String",
],
"variables": [ # List of variables that should be masked from the debug output.
"A String",
],
}
getDeployedConfig(name, x__xgafv=None)
Gets the deployed configuration for an environment.
Args:
name: string, Required. Name of the environment deployed configuration resource. Use the following structure in your request: `organizations/{org}/environments/{env}/deployedConfig` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"addonsConfig": { # RuntimeAddonsConfig defines the runtime configurations for add-ons in an environment. # The latest runtime configurations for add-ons.
"analyticsConfig": { # Runtime configuration for the Analytics add-on. # Runtime configuration for Analytics add-on.
"billingPipelineEnabled": True or False, # If Runtime should send billing data to AX or not.
"enabled": True or False, # If the Analytics is enabled or not.
},
"apiSecurityConfig": { # Runtime configuration for the API Security add-on. # Runtime configuration for API Security add-on.
"enabled": True or False, # If the API Security is enabled or not.
},
"name": "A String", # Name of the addons config in the format: `organizations/{org}/environments/{env}/addonsConfig`
"revisionId": "A String", # Revision number used by the runtime to detect config changes.
"uid": "A String", # UID is to detect if config is recreated after deletion. The add-on config will only be deleted when the environment itself gets deleted, thus it will always be the same as the UID of EnvironmentConfig.
},
"arcConfigLocation": "A String", # 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": "A String", # Time that the environment configuration was created.
"dataCollectors": [ # List of data collectors used by the deployments in the environment.
{ # Data collector and its configuration.
"name": "A String", # Name of the data collector in the following format: `organizations/{org}/datacollectors/{datacollector}`
"type": "A String", # Data type accepted by the data collector.
},
],
"debugMask": { # Debug mask that applies to all deployments in the environment.
"faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
"A String",
],
"faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
"A String",
],
"name": "A String", # Name of the debug mask.
"namespaces": { # Map of namespaces to URIs.
"a_key": "A String",
},
"requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
"A String",
],
"requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads.
"A String",
],
"responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
"A String",
],
"responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads.
"A String",
],
"variables": [ # List of variables that should be masked from the debug output.
"A String",
],
},
"deploymentGroups": [ # List of deployment groups in the environment.
{ # DeploymentGroupConfig represents a deployment group that should be present in a particular environment.
"deploymentGroupType": "A String", # Type of the deployment group, which will be either Standard or Extensible.
"name": "A String", # Name of the deployment group in the following format: `organizations/{org}/environments/{env}/deploymentGroups/{group}`.
"revisionId": "A String", # Revision number which can be used by the runtime to detect if the deployment group has changed between two versions.
"uid": "A String", # Unique ID. The ID will only change if the deployment group is deleted and recreated.
},
],
"deployments": [ # List of deployments in the environment.
{ # NEXT ID: 11
"attributes": { # Additional key-value metadata for the deployment.
"a_key": "A String",
},
"basePath": "A String", # Base path where the application will be hosted. Defaults to "/".
"deploymentGroups": [ # The list of deployment groups in which this proxy should be deployed. Not currently populated for shared flows.
"A String",
],
"endpoints": { # A mapping from basepaths to proxy endpoint names in this proxy. Not populated for shared flows.
"a_key": "A String",
},
"location": "A String", # Location of the API proxy bundle as a URI.
"name": "A String", # 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}`
"proxyUid": "A String", # Unique ID of the API proxy revision.
"serviceAccount": "A String", # The service account identity associated with this deployment. If non-empty, will be in the following format: `projects/-/serviceAccounts/{account_email}`
"uid": "A String", # Unique ID. The ID will only change if the deployment is deleted and recreated.
},
],
"envScopedRevisionId": "A String", # 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": { # Feature flags inherited from the organization and environment.
"a_key": "A String",
},
"flowhooks": [ # List of flow hooks in the environment.
{
"continueOnError": True or False, # Flag that specifies whether the flow should abort after an error in the flow hook. Defaults to `true` (continue on error).
"name": "A String", # 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": "A String", # Name of the shared flow to invoke in the following format: `organizations/{org}/sharedflows/{sharedflow}`
},
],
"forwardProxyUri": "A String", # 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": "A String", # 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": [ # List of keystores in the environment.
{
"aliases": [ # Aliases in the keystore.
{
"location": "A String", # Location of the alias file. For example, a Google Cloud Storage URI.
"name": "A String", # Name of the alias revision included in the keystore in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}`
"type": "A String",
},
],
"name": "A String", # Resource name in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}`
},
],
"name": "A String", # Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}`
"provider": "A String", # Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging.
"pubsubTopic": "A String", # Name of the PubSub topic for the environment.
"resourceReferences": [ # List of resource references in the environment.
{
"name": "A String", # Name of the reference in the following format: `organizations/{org}/environments/{env}/references/{reference}`
"resourceName": "A String", # Name of the referenced resource in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` Only references to keystore resources are supported.
},
],
"resources": [ # List of resource versions in the environment.
{
"location": "A String", # Location of the resource as a URI.
"name": "A String", # Resource name in the following format: `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` Only environment-scoped resource files are supported.
},
],
"revisionId": "A String", # Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed.
"sequenceNumber": "A String", # DEPRECATED: Use revision_id.
"targets": [ # List of target servers in the environment. Disabled target servers are not displayed.
{
"enabled": True or False, # Whether the target server is enabled. An empty/omitted value for this field should be interpreted as true.
"host": "A String", # Host name of the target server.
"name": "A String", # Target server revision name in the following format: `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}`
"port": 42, # Port number for the target server.
"protocol": "A String", # The protocol used by this target server.
"tlsInfo": { # TLS settings for the target server.
"ciphers": [ # List of ciphers that are granted access.
"A String",
],
"clientAuthEnabled": True or False, # Flag that specifies whether client-side authentication is enabled for the target server. Enables two-way TLS.
"commonName": { # Common name to validate the target server against.
"matchWildCards": True or False,
"name": "A String",
},
"enabled": True or False, # Flag that specifies whether one-way TLS is enabled. Set to `true` to enable one-way TLS.
"enforce": True or False, # Flag that enforces TLS settings
"ignoreValidationErrors": True or False, # Flag that specifies whether to ignore TLS certificate validation errors. Set to `true` to ignore errors.
"keyAlias": "A String", # Name of the alias used for client-side authentication in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`
"keyAliasReference": { # Reference name and alias pair to use for client-side authentication.
"aliasId": "A String", # Alias ID. Must exist in the keystore referred to by the reference.
"reference": "A String", # Reference name in the following format: `organizations/{org}/environments/{env}/references/{reference}`
},
"protocols": [ # List of TLS protocols that are granted access.
"A String",
],
"trustStore": "A String", # 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": { # NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment. # Trace configurations. Contains config for the environment and config overrides for specific API proxies.
"endpoint": "A String", # Endpoint of the exporter.
"exporter": "A String", # Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.
"name": "A String", # Name of the trace config in the following format: `organizations/{org}/environment/{env}/traceConfig`
"overrides": [ # List of trace configuration overrides for spicific API proxies.
{ # NEXT ID: 7 Trace configuration override for a specific API proxy in an environment.
"apiProxy": "A String", # Name of the API proxy that will have its trace configuration overridden following format: `organizations/{org}/apis/{api}`
"name": "A String", # Name of the trace config override in the following format: `organizations/{org}/environment/{env}/traceConfig/overrides/{override}`
"revisionCreateTime": "A String", # The timestamp that the revision was created or updated.
"revisionId": "A String", # Revision number which can be used by the runtime to detect if the trace config override has changed between two versions.
"samplingConfig": { # 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. # Trace configuration override for a specific API proxy in an environment.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
"uid": "A String", # Unique ID for the configuration override. The ID will only change if the override is deleted and recreated. Corresponds to name's "override" field.
},
],
"revisionCreateTime": "A String", # The timestamp that the revision was created or updated.
"revisionId": "A String", # Revision number which can be used by the runtime to detect if the trace config has changed between two versions.
"samplingConfig": { # 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. # Trace configuration for all API proxies in an environment.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
},
"uid": "A String", # Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated.
}
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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](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 < 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](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # 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.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # 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.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # 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.
},
],
"bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # 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. # 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 principals 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).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # 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.
},
"members": [ # Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `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.
"version": 42, # 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).
}
getSecurityActionsConfig(name, x__xgafv=None)
GetSecurityActionConfig returns the current SecurityActions configuration.
Args:
name: string, Required. The name of the SecurityActionsConfig to retrieve. This will always be: `organizations/{org}/environments/{env}/security_actions_config` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # SecurityActionsConfig reflects the current state of the SecurityActions feature. This is a singleton resource: https://google.aip.dev/156
"enabled": True or False, # The flag that controls whether this feature is enabled. This is `unset` by default. When this flag is `false`, even if individual rules are enabled, no SecurityActions will be enforced.
"name": "A String", # This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config`
"updateTime": "A String", # Output only. The update time for configuration.
}
getTraceConfig(name, x__xgafv=None)
Get distributed trace configuration in an environment.
Args:
name: string, Required. Name of the trace configuration. Use the following structure in your request: "organizations/*/environments/*/traceConfig". (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # TraceConfig defines the configurations in an environment of distributed trace.
"endpoint": "A String", # Required. Endpoint of the exporter.
"exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.
"samplingConfig": { # 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. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
}
modifyEnvironment(name, body=None, updateMask=None, x__xgafv=None)
Updates properties for an Apigee environment with patch semantics using a field mask. **Note:** Not supported for Apigee hybrid.
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{environment}`. (required)
body: object, The request body.
The object takes the form of:
{
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"deploymentType": "A String", # 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](/apigee/docs/api-platform/local-development/overview#prevented-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": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"forwardProxyUri": "A String", # 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": True or False,
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"nodeConfig": { # NodeConfig for setting the min/max number of nodes associated with the environment. # Optional. NodeConfig of the environment.
"currentAggregateNodeCount": "A String", # Output only. The current total number of gateway nodes that each environment currently has across all instances.
"maxNodeCount": "A String", # Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
"minNodeCount": "A String", # Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
},
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
"type": "A String", # Optional. EnvironmentType selected for the environment.
}
updateMask: string, List of fields to be updated. Fields that can be updated: node_config.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
setIamPolicy(resource, body=None, x__xgafv=None)
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://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # 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](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 < 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](https://cloud.google.com/iam/docs/). # 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 Google Cloud services (such as Projects) might reject them.
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # 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.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # 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.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # 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.
},
],
"bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # 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. # 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 principals 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).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # 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.
},
"members": [ # Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `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.
"version": 42, # 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).
},
"updateMask": "A String", # 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"`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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](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 < 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](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # 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.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # 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.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # 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.
},
],
"bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # 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. # 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 principals 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).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # 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.
},
"members": [ # Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `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.
"version": 42, # 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).
}
subscribe(parent, x__xgafv=None)
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.
Args:
parent: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Pub/Sub subscription of an environment.
"name": "A String", # Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription "projects/foo/subscription/bar"`
}
testIamPermissions(resource, body=None, x__xgafv=None)
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).
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # 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).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}
unsubscribe(parent, body=None, x__xgafv=None)
Deletes a subscription for the environment's Pub/Sub topic.
Args:
parent: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
body: object, The request body.
The object takes the form of:
{ # Pub/Sub subscription of an environment.
"name": "A String", # Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription "projects/foo/subscription/bar"`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}
update(name, body=None, x__xgafv=None)
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). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment.
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
body: object, The request body.
The object takes the form of:
{
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"deploymentType": "A String", # 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](/apigee/docs/api-platform/local-development/overview#prevented-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": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"forwardProxyUri": "A String", # 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": True or False,
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"nodeConfig": { # NodeConfig for setting the min/max number of nodes associated with the environment. # Optional. NodeConfig of the environment.
"currentAggregateNodeCount": "A String", # Output only. The current total number of gateway nodes that each environment currently has across all instances.
"maxNodeCount": "A String", # Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
"minNodeCount": "A String", # Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
},
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
"type": "A String", # Optional. EnvironmentType selected for the environment.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"deploymentType": "A String", # 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](/apigee/docs/api-platform/local-development/overview#prevented-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": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"forwardProxyUri": "A String", # 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": True or False,
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"nodeConfig": { # NodeConfig for setting the min/max number of nodes associated with the environment. # Optional. NodeConfig of the environment.
"currentAggregateNodeCount": "A String", # Output only. The current total number of gateway nodes that each environment currently has across all instances.
"maxNodeCount": "A String", # Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
"minNodeCount": "A String", # Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
},
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
"type": "A String", # Optional. EnvironmentType selected for the environment.
}
updateDebugmask(name, body=None, replaceRepeatedFields=None, updateMask=None, x__xgafv=None)
Updates the debug mask singleton resource for an environment.
Args:
name: string, Name of the debug mask. (required)
body: object, The request body.
The object takes the form of:
{
"faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
"A String",
],
"faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
"A String",
],
"name": "A String", # Name of the debug mask.
"namespaces": { # Map of namespaces to URIs.
"a_key": "A String",
},
"requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
"A String",
],
"requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads.
"A String",
],
"responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
"A String",
],
"responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads.
"A String",
],
"variables": [ # List of variables that should be masked from the debug output.
"A String",
],
}
replaceRepeatedFields: boolean, 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).
updateMask: string, Field debug mask to support partial updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"faultJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
"A String",
],
"faultXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
"A String",
],
"name": "A String", # Name of the debug mask.
"namespaces": { # Map of namespaces to URIs.
"a_key": "A String",
},
"requestJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
"A String",
],
"requestXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML request message payloads.
"A String",
],
"responseJSONPaths": [ # List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
"A String",
],
"responseXPaths": [ # List of XPaths that specify the XML elements to be filtered from XML response message payloads.
"A String",
],
"variables": [ # List of variables that should be masked from the debug output.
"A String",
],
}
updateEnvironment(name, body=None, x__xgafv=None)
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). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment.
Args:
name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
body: object, The request body.
The object takes the form of:
{
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"deploymentType": "A String", # 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](/apigee/docs/api-platform/local-development/overview#prevented-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": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"forwardProxyUri": "A String", # 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": True or False,
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"nodeConfig": { # NodeConfig for setting the min/max number of nodes associated with the environment. # Optional. NodeConfig of the environment.
"currentAggregateNodeCount": "A String", # Output only. The current total number of gateway nodes that each environment currently has across all instances.
"maxNodeCount": "A String", # Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
"minNodeCount": "A String", # Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
},
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
"type": "A String", # Optional. EnvironmentType selected for the environment.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiProxyType": "A String", # Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
"createdAt": "A String", # Output only. Creation time of this environment as milliseconds since epoch.
"deploymentType": "A String", # 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](/apigee/docs/api-platform/local-development/overview#prevented-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": "A String", # Optional. Description of the environment.
"displayName": "A String", # Optional. Display name for this environment.
"forwardProxyUri": "A String", # 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": True or False,
"lastModifiedAt": "A String", # Output only. Last modification time of this environment as milliseconds since epoch.
"name": "A String", # Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$`
"nodeConfig": { # NodeConfig for setting the min/max number of nodes associated with the environment. # Optional. NodeConfig of the environment.
"currentAggregateNodeCount": "A String", # Output only. The current total number of gateway nodes that each environment currently has across all instances.
"maxNodeCount": "A String", # Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
"minNodeCount": "A String", # Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
},
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Key-value pairs that may be used for customizing the environment.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
"type": "A String", # Optional. EnvironmentType selected for the environment.
}
updateSecurityActionsConfig(name, body=None, updateMask=None, x__xgafv=None)
UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level.
Args:
name: string, This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config` (required)
body: object, The request body.
The object takes the form of:
{ # SecurityActionsConfig reflects the current state of the SecurityActions feature. This is a singleton resource: https://google.aip.dev/156
"enabled": True or False, # The flag that controls whether this feature is enabled. This is `unset` by default. When this flag is `false`, even if individual rules are enabled, no SecurityActions will be enforced.
"name": "A String", # This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config`
"updateTime": "A String", # Output only. The update time for configuration.
}
updateMask: string, The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # SecurityActionsConfig reflects the current state of the SecurityActions feature. This is a singleton resource: https://google.aip.dev/156
"enabled": True or False, # The flag that controls whether this feature is enabled. This is `unset` by default. When this flag is `false`, even if individual rules are enabled, no SecurityActions will be enforced.
"name": "A String", # This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config`
"updateTime": "A String", # Output only. The update time for configuration.
}
updateTraceConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.
Args:
name: string, Required. Name of the trace configuration. Use the following structure in your request: "organizations/*/environments/*/traceConfig". (required)
body: object, The request body.
The object takes the form of:
{ # TraceConfig defines the configurations in an environment of distributed trace.
"endpoint": "A String", # Required. Endpoint of the exporter.
"exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.
"samplingConfig": { # 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. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
}
updateMask: string, List of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # TraceConfig defines the configurations in an environment of distributed trace.
"endpoint": "A String", # Required. Endpoint of the exporter.
"exporter": "A String", # Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters.
"samplingConfig": { # 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. # Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API.
"sampler": "A String", # Sampler of distributed tracing. OFF is the default value.
"samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
},
}