Documentation

Google_Service_Apigee_Resource_OrganizationsEnvironments extends Google_Service_Resource
in package

The "environments" collection of methods.

Typical usage is: $apigeeService = new Google_Service_Apigee(...); $environments = $apigeeService->environments;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Apigee_GoogleLongrunningOperation
Creates an environment in an organization. (environments.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Apigee_GoogleLongrunningOperation
Deletes an environment from an organization. (environments.delete)
get()  : Google_Service_Apigee_GoogleCloudApigeeV1Environment
Gets environment details. (environments.get)
getDebugmask()  : Google_Service_Apigee_GoogleCloudApigeeV1DebugMask
Gets the debug mask singleton resource for an environment.
getDeployedConfig()  : Google_Service_Apigee_GoogleCloudApigeeV1EnvironmentConfig
Gets the deployed configuration for an environment.
getIamPolicy()  : Google_Service_Apigee_GoogleIamV1Policy
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. (environments.getIamPolicy)
setIamPolicy()  : Google_Service_Apigee_GoogleIamV1Policy
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()  : Google_Service_Apigee_GoogleCloudApigeeV1Subscription
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()  : Google_Service_Apigee_GoogleIamV1TestIamPermissionsResponse
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()  : Google_Service_Apigee_GoogleProtobufEmpty
Deletes a subscription for the environment's Pub/Sub topic.
update()  : Google_Service_Apigee_GoogleCloudApigeeV1Environment
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). (environments.update)
updateDebugmask()  : Google_Service_Apigee_GoogleCloudApigeeV1DebugMask
Updates the debug mask singleton resource for an environment.
updateEnvironment()  : Google_Service_Apigee_GoogleCloudApigeeV1Environment
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). (environments.updateEnvironment)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

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

public create(string $parent, Google_Service_Apigee_GoogleCloudApigeeV1Environment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleLongrunningOperation
Parameters
$parent : string

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

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Environment
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string name Optional. Name of the environment. Alternatively, the name may be specified in the request body in the name field.

Return values
Google_Service_Apigee_GoogleLongrunningOperation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes an environment from an organization. (environments.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleLongrunningOperation
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleLongrunningOperation —

get()

Gets environment details. (environments.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Environment
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Environment —

getDebugmask()

Gets the debug mask singleton resource for an environment.

public getDebugmask(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1DebugMask

(environments.getDebugmask)

Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1DebugMask —

getDeployedConfig()

Gets the deployed configuration for an environment.

public getDeployedConfig(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1EnvironmentConfig

(environments.getDeployedConfig)

Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1EnvironmentConfig —

getIamPolicy()

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

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleIamV1Policy
Parameters
$resource : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies).

Return values
Google_Service_Apigee_GoogleIamV1Policy —

setIamPolicy()

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.

public setIamPolicy(string $resource, Google_Service_Apigee_GoogleIamV1SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleIamV1Policy

(environments.setIamPolicy)

Parameters
$resource : string

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

$postBody : Google_Service_Apigee_GoogleIamV1SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleIamV1Policy —

subscribe()

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)

public subscribe(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Subscription
Parameters
$parent : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Subscription —

testIamPermissions()

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)

public testIamPermissions(string $resource, Google_Service_Apigee_GoogleIamV1TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleIamV1TestIamPermissionsResponse
Parameters
$resource : string

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

$postBody : Google_Service_Apigee_GoogleIamV1TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleIamV1TestIamPermissionsResponse —

unsubscribe()

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

public unsubscribe(string $parent, Google_Service_Apigee_GoogleCloudApigeeV1Subscription $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleProtobufEmpty

(environments.unsubscribe)

Parameters
$parent : string

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

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Subscription
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleProtobufEmpty —

update()

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

public update(string $name, Google_Service_Apigee_GoogleCloudApigeeV1Environment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Environment
Parameters
$name : string

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

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Environment
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Environment —

updateDebugmask()

Updates the debug mask singleton resource for an environment.

public updateDebugmask(string $name, Google_Service_Apigee_GoogleCloudApigeeV1DebugMask $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1DebugMask

(environments.updateDebugmask)

Parameters
$name : string

Name of the debug mask.

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1DebugMask
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Field debug mask to support partial updates.

opt_param

bool replaceRepeatedFields 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).

Return values
Google_Service_Apigee_GoogleCloudApigeeV1DebugMask —

updateEnvironment()

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

public updateEnvironment(string $name, Google_Service_Apigee_GoogleCloudApigeeV1Environment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Environment
Parameters
$name : string

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

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Environment
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Environment —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results