Google Cloud Dataproc V1 Client - Class AutoscalingPolicyServiceClient (3.11.0)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class AutoscalingPolicyServiceClient.

Service Description: The API interface for managing autoscaling policies in the Dataproc API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Dataproc\V1\AutoscalingPolicyServiceClient for the stable implementation

Namespace

Google \ Cloud \ Dataproc \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createAutoscalingPolicy

Creates new autoscaling policy.

The async variant is Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient::createAutoscalingPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\CreateAutoscalingPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dataproc\V1\AutoscalingPolicy`

deleteAutoscalingPolicy

Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

The async variant is Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient::deleteAutoscalingPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\DeleteAutoscalingPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getAutoscalingPolicy

Retrieves autoscaling policy.

The async variant is Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient::getAutoscalingPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\GetAutoscalingPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dataproc\V1\AutoscalingPolicy`

listAutoscalingPolicies

Lists autoscaling policies in the project.

The async variant is Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient::listAutoscalingPoliciesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\ListAutoscalingPoliciesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateAutoscalingPolicy

Updates (replaces) autoscaling policy.

Disabled check for update_mask, because all updates will be full replacements.

The async variant is Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient::updateAutoscalingPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\UpdateAutoscalingPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dataproc\V1\AutoscalingPolicy`

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\TestIamPermissionsResponse`

createAutoscalingPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\CreateAutoscalingPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteAutoscalingPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\DeleteAutoscalingPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAutoscalingPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\GetAutoscalingPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listAutoscalingPoliciesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\ListAutoscalingPoliciesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateAutoscalingPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\UpdateAutoscalingPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::autoscalingPolicyName

Formats a string containing the fully-qualified path to represent a autoscaling_policy resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`autoscalingPolicy`	`string`

Returns
Type	Description
`string`	The formatted autoscaling_policy resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::projectLocationAutoscalingPolicyName

Formats a string containing the fully-qualified path to represent a project_location_autoscaling_policy resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`autoscalingPolicy`	`string`

Returns
Type	Description
`string`	The formatted project_location_autoscaling_policy resource.

static::projectRegionAutoscalingPolicyName

Formats a string containing the fully-qualified path to represent a project_region_autoscaling_policy resource.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`autoscalingPolicy`	`string`

Returns
Type	Description
`string`	The formatted project_region_autoscaling_policy resource.

static::regionName

Formats a string containing the fully-qualified path to represent a region resource.

Parameters
Name	Description
`project`	`string`
`region`	`string`

Returns
Type	Description
`string`	The formatted region resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

autoscalingPolicy: projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}
location: projects/{project}/locations/{location}
projectLocationAutoscalingPolicy: projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}
projectRegionAutoscalingPolicy: projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}
region: projects/{project}/regions/{region}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.