class OrganizationsEnvironments extends Resource (View source)

The "environments" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $environments = $apigeeService->organizations_environments;

Methods

create(string $parent, GoogleCloudApigeeV1Environment $postBody, array $optParams = [])

Creates an environment in an organization. (environments.create)

delete(string $name, array $optParams = [])

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.

get(string $name, array $optParams = [])

Gets environment details. (environments.get)

getAddonsConfig(string $name, array $optParams = [])

Gets the add-ons config of an environment. (environments.getAddonsConfig)

getApiSecurityRuntimeConfig(string $name, array $optParams = [])

Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config. (environments.getApiSecurityRuntimeConfig)

getDebugmask(string $name, array $optParams = [])

Gets the debug mask singleton resource for an environment.

getDeployedConfig(string $name, array $optParams = [])

Gets the deployed configuration for an environment.

getIamPolicy(string $resource, array $optParams = [])

Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.getIamPolicy permission to call this API.

getSecurityActionsConfig(string $name, array $optParams = [])

GetSecurityActionConfig returns the current SecurityActions configuration.

getTraceConfig(string $name, array $optParams = [])

Get distributed trace configuration in an environment.

modifyEnvironment(string $name, GoogleCloudApigeeV1Environment $postBody, array $optParams = [])

Updates properties for an Apigee environment with patch semantics using a field mask. Note: Not supported for Apigee hybrid.

setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

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. You must have the apigee.environments.setIamPolicy permission to call this API.

subscribe(string $parent, array $optParams = [])

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. (environments.subscribe)

testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

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). (environments.testIamPermissions)

unsubscribe(string $parent, GoogleCloudApigeeV1Subscription $postBody, array $optParams = [])

Deletes a subscription for the environment's Pub/Sub topic.

update(string $name, GoogleCloudApigeeV1Environment $postBody, array $optParams = [])

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. Note: Both PUT and POST methods are supported for updating an existing environment. (environments.update)

updateDebugmask(string $name, GoogleCloudApigeeV1DebugMask $postBody, array $optParams = [])

Updates the debug mask singleton resource for an environment.

updateEnvironment(string $name, GoogleCloudApigeeV1Environment $postBody, array $optParams = [])

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. Note: Both PUT and POST methods are supported for updating an existing environment. (environments.updateEnvironment)

updateSecurityActionsConfig(string $name, GoogleCloudApigeeV1SecurityActionsConfig $postBody, array $optParams = [])

UpdateSecurityActionConfig updates the current SecurityActions configuration.

updateTraceConfig(string $name, GoogleCloudApigeeV1TraceConfig $postBody, array $optParams = [])

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.

Details

GoogleLongrunningOperation create(string $parent, GoogleCloudApigeeV1Environment $postBody, array $optParams = [])

Creates an environment in an organization. (environments.create)

Parameters

string $parent

Required. Name of the organization in which the environment will be created. Use the following structure in your request: organizations/{org}

GoogleCloudApigeeV1Environment $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

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.

(environments.delete)

Parameters

string $name

Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{env}

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudApigeeV1Environment get(string $name, array $optParams = [])

Gets environment details. (environments.get)

Parameters

string $name

Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{env}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Environment

Exceptions

Exception

GoogleCloudApigeeV1AddonsConfig getAddonsConfig(string $name, array $optParams = [])

Gets the add-ons config of an environment. (environments.getAddonsConfig)

Parameters

string $name

Required. Name of the add-ons config. Must be in the format of /organizations/{org}/environments/{env}/addonsConfig

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AddonsConfig

Exceptions

Exception

GoogleCloudApigeeV1ApiSecurityRuntimeConfig getApiSecurityRuntimeConfig(string $name, array $optParams = [])

Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config. (environments.getApiSecurityRuntimeConfig)

Parameters

string $name

Required. Name of the environment API Security Runtime configuration resource. Use the following structure in your request: organizations/{org}/environments/{env}/apiSecurityRuntimeConfig

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiSecurityRuntimeConfig

Exceptions

Exception

GoogleCloudApigeeV1DebugMask getDebugmask(string $name, array $optParams = [])

Gets the debug mask singleton resource for an environment.

(environments.getDebugmask)

Parameters

string $name

Required. Name of the debug mask. Use the following structure in your request: organizations/{org}/environments/{env}/debugmask.

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DebugMask

Exceptions

Exception

GoogleCloudApigeeV1EnvironmentConfig getDeployedConfig(string $name, array $optParams = [])

Gets the deployed configuration for an environment.

(environments.getDeployedConfig)

Parameters

string $name

Required. Name of the environment deployed configuration resource. Use the following structure in your request: organizations/{org}/environments/{env}/deployedConfig

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1EnvironmentConfig

Exceptions

Exception

GoogleIamV1Policy getIamPolicy(string $resource, array $optParams = [])

Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.getIamPolicy permission to call this API.

(environments.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleCloudApigeeV1SecurityActionsConfig getSecurityActionsConfig(string $name, array $optParams = [])

GetSecurityActionConfig returns the current SecurityActions configuration.

(environments.getSecurityActionsConfig)

Parameters

string $name

Required. The name of the SecurityActionsConfig to retrieve. This will always be: organizations/{org}/environments/{env}/security_actions_config

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityActionsConfig

Exceptions

Exception

GoogleCloudApigeeV1TraceConfig getTraceConfig(string $name, array $optParams = [])

Get distributed trace configuration in an environment.

(environments.getTraceConfig)

Parameters

string $name

Required. Name of the trace configuration. Use the following structure in your request: "organizations/environments/traceConfig".

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1TraceConfig

Exceptions

Exception

GoogleLongrunningOperation modifyEnvironment(string $name, GoogleCloudApigeeV1Environment $postBody, array $optParams = [])

Updates properties for an Apigee environment with patch semantics using a field mask. Note: Not supported for Apigee hybrid.

(environments.modifyEnvironment)

Parameters

string $name

Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{environment}.

GoogleCloudApigeeV1Environment $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleIamV1Policy setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

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. You must have the apigee.environments.setIamPolicy permission to call this API.

(environments.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

GoogleIamV1SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleCloudApigeeV1Subscription subscribe(string $parent, array $optParams = [])

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. (environments.subscribe)

Parameters

string $parent

Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{env}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Subscription

Exceptions

Exception

GoogleIamV1TestIamPermissionsResponse testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

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). (environments.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

GoogleIamV1TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1TestIamPermissionsResponse

Exceptions

Exception

GoogleProtobufEmpty unsubscribe(string $parent, GoogleCloudApigeeV1Subscription $postBody, array $optParams = [])

Deletes a subscription for the environment's Pub/Sub topic.

(environments.unsubscribe)

Parameters

string $parent

Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{env}

GoogleCloudApigeeV1Subscription $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudApigeeV1Environment update(string $name, GoogleCloudApigeeV1Environment $postBody, array $optParams = [])

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. Note: Both PUT and POST methods are supported for updating an existing environment. (environments.update)

Parameters

string $name

Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{env}

GoogleCloudApigeeV1Environment $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Environment

Exceptions

Exception

GoogleCloudApigeeV1DebugMask updateDebugmask(string $name, GoogleCloudApigeeV1DebugMask $postBody, array $optParams = [])

Updates the debug mask singleton resource for an environment.

(environments.updateDebugmask)

Parameters

string $name

Name of the debug mask.

GoogleCloudApigeeV1DebugMask $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DebugMask

Exceptions

Exception

GoogleCloudApigeeV1Environment updateEnvironment(string $name, GoogleCloudApigeeV1Environment $postBody, array $optParams = [])

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. Note: Both PUT and POST methods are supported for updating an existing environment. (environments.updateEnvironment)

Parameters

string $name

Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{env}

GoogleCloudApigeeV1Environment $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Environment

Exceptions

Exception

GoogleCloudApigeeV1SecurityActionsConfig updateSecurityActionsConfig(string $name, GoogleCloudApigeeV1SecurityActionsConfig $postBody, array $optParams = [])

UpdateSecurityActionConfig updates the current SecurityActions configuration.

This method is used to enable/disable the feature at the environment level. (environments.updateSecurityActionsConfig)

Parameters

string $name

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

GoogleCloudApigeeV1SecurityActionsConfig $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityActionsConfig

Exceptions

Exception

GoogleCloudApigeeV1TraceConfig updateTraceConfig(string $name, GoogleCloudApigeeV1TraceConfig $postBody, array $optParams = [])

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.

(environments.updateTraceConfig)

Parameters

string $name

Required. Name of the trace configuration. Use the following structure in your request: "organizations/environments/traceConfig".

GoogleCloudApigeeV1TraceConfig $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1TraceConfig

Exceptions

Exception