OrganizationsEnvironments
class OrganizationsEnvironments extends Resource (View source)
The "environments" collection of methods.
Typical usage is:
$apigeeService = new Google\Service\Apigee(...);
$environments = $apigeeService->organizations_environments;
Methods
Creates an environment in an organization. (environments.create)
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. (environments.get)
Gets the add-ons config of an environment. (environments.getAddonsConfig)
Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config. (environments.getApiSecurityRuntimeConfig)
Gets the debug mask singleton resource for an environment.
Gets the deployed configuration for an environment.
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.
GetSecurityActionConfig returns the current SecurityActions configuration.
Get distributed trace configuration in an environment.
Updates properties for an Apigee environment with patch semantics using a field mask. Note: Not supported for Apigee hybrid.
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.
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)
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)
Deletes a subscription for the environment's Pub/Sub topic.
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)
Updates the debug mask singleton resource for an environment.
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)
UpdateSecurityActionConfig updates the current SecurityActions configuration.
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)
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)
GoogleCloudApigeeV1Environment
get(string $name, array $optParams = [])
Gets environment details. (environments.get)
GoogleCloudApigeeV1AddonsConfig
getAddonsConfig(string $name, array $optParams = [])
Gets the add-ons config of an environment. (environments.getAddonsConfig)
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)
GoogleCloudApigeeV1DebugMask
getDebugmask(string $name, array $optParams = [])
Gets the debug mask singleton resource for an environment.
(environments.getDebugmask)
GoogleCloudApigeeV1EnvironmentConfig
getDeployedConfig(string $name, array $optParams = [])
Gets the deployed configuration for an environment.
(environments.getDeployedConfig)
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)
GoogleCloudApigeeV1SecurityActionsConfig
getSecurityActionsConfig(string $name, array $optParams = [])
GetSecurityActionConfig returns the current SecurityActions configuration.
(environments.getSecurityActionsConfig)
GoogleCloudApigeeV1TraceConfig
getTraceConfig(string $name, array $optParams = [])
Get distributed trace configuration in an environment.
(environments.getTraceConfig)
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)
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)
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)
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)
GoogleProtobufEmpty
unsubscribe(string $parent, GoogleCloudApigeeV1Subscription $postBody, array $optParams = [])
Deletes a subscription for the environment's Pub/Sub topic.
(environments.unsubscribe)
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)
GoogleCloudApigeeV1DebugMask
updateDebugmask(string $name, GoogleCloudApigeeV1DebugMask $postBody, array $optParams = [])
Updates the debug mask singleton resource for an environment.
(environments.updateDebugmask)
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)
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)
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)