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. Sample code to get started:
$autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();
try {
$formattedParent = $autoscalingPolicyServiceClient->regionName('[PROJECT]', '[REGION]');
$policy = new AutoscalingPolicy();
$response = $autoscalingPolicyServiceClient->createAutoscalingPolicy($formattedParent, $policy);
} finally {
$autoscalingPolicyServiceClient->close();
}
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.
Methods
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. |
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. |
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. |
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. |
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. |
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. |
__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 |
↳ 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 |
↳ 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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
policy |
Google\Cloud\Dataproc\V1\AutoscalingPolicy
Required. The autoscaling policy to create. |
optionalArgs |
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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\AutoscalingPolicy;
use Google\Cloud\Dataproc\V1\AutoscalingPolicyServiceClient;
use Google\Cloud\Dataproc\V1\BasicAutoscalingAlgorithm;
use Google\Cloud\Dataproc\V1\BasicYarnAutoscalingConfig;
use Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig;
use Google\Protobuf\Duration;
/**
* @param string $formattedParent The "resource name" of the region or location, as described
* in https://cloud.google.com/apis/design/resource_names.
*
* * For `projects.regions.autoscalingPolicies.create`, the resource name
* of the region has the following format:
* `projects/{project_id}/regions/{region}`
*
* * For `projects.locations.autoscalingPolicies.create`, the resource name
* of the location has the following format:
* `projects/{project_id}/locations/{location}`
* Please see {@see AutoscalingPolicyServiceClient::regionName()} for help formatting this field.
* @param float $policyBasicAlgorithmYarnConfigScaleUpFactor Fraction of average YARN pending memory in the last cooldown
* period for which to add workers. A scale-up factor of 1.0 will result in
* scaling up so that there is no pending memory remaining after the update
* (more aggressive scaling). A scale-up factor closer to 0 will result in a
* smaller magnitude of scaling up (less aggressive scaling). See [How
* autoscaling
* works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
* for more information.
*
* Bounds: [0.0, 1.0].
* @param float $policyBasicAlgorithmYarnConfigScaleDownFactor Fraction of average YARN pending memory in the last cooldown
* period for which to remove workers. A scale-down factor of 1 will result in
* scaling down so that there is no available memory remaining after the
* update (more aggressive scaling). A scale-down factor of 0 disables
* removing workers, which can be beneficial for autoscaling a single job.
* See [How autoscaling
* works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
* for more information.
*
* Bounds: [0.0, 1.0].
* @param int $policyWorkerConfigMaxInstances Maximum number of instances for this group. Required for primary
* workers. Note that by default, clusters will not use secondary workers.
* Required for secondary workers if the minimum secondary instances is set.
*
* Primary workers - Bounds: [min_instances, ).
* Secondary workers - Bounds: [min_instances, ). Default: 0.
*/
function create_autoscaling_policy_sample(
string $formattedParent,
float $policyBasicAlgorithmYarnConfigScaleUpFactor,
float $policyBasicAlgorithmYarnConfigScaleDownFactor,
int $policyWorkerConfigMaxInstances
): void {
// Create a client.
$autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$policyBasicAlgorithmYarnConfigGracefulDecommissionTimeout = new Duration();
$policyBasicAlgorithmYarnConfig = (new BasicYarnAutoscalingConfig())
->setGracefulDecommissionTimeout($policyBasicAlgorithmYarnConfigGracefulDecommissionTimeout)
->setScaleUpFactor($policyBasicAlgorithmYarnConfigScaleUpFactor)
->setScaleDownFactor($policyBasicAlgorithmYarnConfigScaleDownFactor);
$policyBasicAlgorithm = (new BasicAutoscalingAlgorithm())
->setYarnConfig($policyBasicAlgorithmYarnConfig);
$policyWorkerConfig = (new InstanceGroupAutoscalingPolicyConfig())
->setMaxInstances($policyWorkerConfigMaxInstances);
$policy = (new AutoscalingPolicy())
->setBasicAlgorithm($policyBasicAlgorithm)
->setWorkerConfig($policyWorkerConfig);
// Call the API and handle any network failures.
try {
/** @var AutoscalingPolicy $response */
$response = $autoscalingPolicyServiceClient->createAutoscalingPolicy($formattedParent, $policy);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = AutoscalingPolicyServiceClient::regionName('[PROJECT]', '[REGION]');
$policyBasicAlgorithmYarnConfigScaleUpFactor = 0.0;
$policyBasicAlgorithmYarnConfigScaleDownFactor = 0.0;
$policyWorkerConfigMaxInstances = 0;
create_autoscaling_policy_sample(
$formattedParent,
$policyBasicAlgorithmYarnConfigScaleUpFactor,
$policyBasicAlgorithmYarnConfigScaleDownFactor,
$policyWorkerConfigMaxInstances
);
}
deleteAutoscalingPolicy
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
optionalArgs |
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\AutoscalingPolicyServiceClient;
/**
* @param string $formattedName The "resource name" of the autoscaling policy, as described
* in https://cloud.google.com/apis/design/resource_names.
*
* * For `projects.regions.autoscalingPolicies.delete`, the resource name
* of the policy has the following format:
* `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
*
* * For `projects.locations.autoscalingPolicies.delete`, the resource name
* of the policy has the following format:
* `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
* Please see {@see AutoscalingPolicyServiceClient::autoscalingPolicyName()} for help formatting this field.
*/
function delete_autoscaling_policy_sample(string $formattedName): void
{
// Create a client.
$autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();
// Call the API and handle any network failures.
try {
$autoscalingPolicyServiceClient->deleteAutoscalingPolicy($formattedName);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = AutoscalingPolicyServiceClient::autoscalingPolicyName(
'[PROJECT]',
'[LOCATION]',
'[AUTOSCALING_POLICY]'
);
delete_autoscaling_policy_sample($formattedName);
}
getAutoscalingPolicy
Retrieves autoscaling policy.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
optionalArgs |
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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\AutoscalingPolicy;
use Google\Cloud\Dataproc\V1\AutoscalingPolicyServiceClient;
/**
* @param string $formattedName The "resource name" of the autoscaling policy, as described
* in https://cloud.google.com/apis/design/resource_names.
*
* * For `projects.regions.autoscalingPolicies.get`, the resource name
* of the policy has the following format:
* `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
*
* * For `projects.locations.autoscalingPolicies.get`, the resource name
* of the policy has the following format:
* `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
* Please see {@see AutoscalingPolicyServiceClient::autoscalingPolicyName()} for help formatting this field.
*/
function get_autoscaling_policy_sample(string $formattedName): void
{
// Create a client.
$autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();
// Call the API and handle any network failures.
try {
/** @var AutoscalingPolicy $response */
$response = $autoscalingPolicyServiceClient->getAutoscalingPolicy($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = AutoscalingPolicyServiceClient::autoscalingPolicyName(
'[PROJECT]',
'[LOCATION]',
'[AUTOSCALING_POLICY]'
);
get_autoscaling_policy_sample($formattedName);
}
listAutoscalingPolicies
Lists autoscaling policies in the project.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataproc\V1\AutoscalingPolicy;
use Google\Cloud\Dataproc\V1\AutoscalingPolicyServiceClient;
/**
* @param string $formattedParent The "resource name" of the region or location, as described
* in https://cloud.google.com/apis/design/resource_names.
*
* * For `projects.regions.autoscalingPolicies.list`, the resource name
* of the region has the following format:
* `projects/{project_id}/regions/{region}`
*
* * For `projects.locations.autoscalingPolicies.list`, the resource name
* of the location has the following format:
* `projects/{project_id}/locations/{location}`
* Please see {@see AutoscalingPolicyServiceClient::regionName()} for help formatting this field.
*/
function list_autoscaling_policies_sample(string $formattedParent): void
{
// Create a client.
$autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $autoscalingPolicyServiceClient->listAutoscalingPolicies($formattedParent);
/** @var AutoscalingPolicy $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = AutoscalingPolicyServiceClient::regionName('[PROJECT]', '[REGION]');
list_autoscaling_policies_sample($formattedParent);
}
updateAutoscalingPolicy
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
| Parameters | |
|---|---|
| Name | Description |
policy |
Google\Cloud\Dataproc\V1\AutoscalingPolicy
Required. The updated autoscaling policy. |
optionalArgs |
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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\AutoscalingPolicy;
use Google\Cloud\Dataproc\V1\AutoscalingPolicyServiceClient;
use Google\Cloud\Dataproc\V1\BasicAutoscalingAlgorithm;
use Google\Cloud\Dataproc\V1\BasicYarnAutoscalingConfig;
use Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig;
use Google\Protobuf\Duration;
/**
* @param float $policyBasicAlgorithmYarnConfigScaleUpFactor Fraction of average YARN pending memory in the last cooldown
* period for which to add workers. A scale-up factor of 1.0 will result in
* scaling up so that there is no pending memory remaining after the update
* (more aggressive scaling). A scale-up factor closer to 0 will result in a
* smaller magnitude of scaling up (less aggressive scaling). See [How
* autoscaling
* works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
* for more information.
*
* Bounds: [0.0, 1.0].
* @param float $policyBasicAlgorithmYarnConfigScaleDownFactor Fraction of average YARN pending memory in the last cooldown
* period for which to remove workers. A scale-down factor of 1 will result in
* scaling down so that there is no available memory remaining after the
* update (more aggressive scaling). A scale-down factor of 0 disables
* removing workers, which can be beneficial for autoscaling a single job.
* See [How autoscaling
* works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
* for more information.
*
* Bounds: [0.0, 1.0].
* @param int $policyWorkerConfigMaxInstances Maximum number of instances for this group. Required for primary
* workers. Note that by default, clusters will not use secondary workers.
* Required for secondary workers if the minimum secondary instances is set.
*
* Primary workers - Bounds: [min_instances, ).
* Secondary workers - Bounds: [min_instances, ). Default: 0.
*/
function update_autoscaling_policy_sample(
float $policyBasicAlgorithmYarnConfigScaleUpFactor,
float $policyBasicAlgorithmYarnConfigScaleDownFactor,
int $policyWorkerConfigMaxInstances
): void {
// Create a client.
$autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$policyBasicAlgorithmYarnConfigGracefulDecommissionTimeout = new Duration();
$policyBasicAlgorithmYarnConfig = (new BasicYarnAutoscalingConfig())
->setGracefulDecommissionTimeout($policyBasicAlgorithmYarnConfigGracefulDecommissionTimeout)
->setScaleUpFactor($policyBasicAlgorithmYarnConfigScaleUpFactor)
->setScaleDownFactor($policyBasicAlgorithmYarnConfigScaleDownFactor);
$policyBasicAlgorithm = (new BasicAutoscalingAlgorithm())
->setYarnConfig($policyBasicAlgorithmYarnConfig);
$policyWorkerConfig = (new InstanceGroupAutoscalingPolicyConfig())
->setMaxInstances($policyWorkerConfigMaxInstances);
$policy = (new AutoscalingPolicy())
->setBasicAlgorithm($policyBasicAlgorithm)
->setWorkerConfig($policyWorkerConfig);
// Call the API and handle any network failures.
try {
/** @var AutoscalingPolicy $response */
$response = $autoscalingPolicyServiceClient->updateAutoscalingPolicy($policy);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$policyBasicAlgorithmYarnConfigScaleUpFactor = 0.0;
$policyBasicAlgorithmYarnConfigScaleDownFactor = 0.0;
$policyWorkerConfigMaxInstances = 0;
update_autoscaling_policy_sample(
$policyBasicAlgorithmYarnConfigScaleUpFactor,
$policyBasicAlgorithmYarnConfigScaleDownFactor,
$policyWorkerConfigMaxInstances
);
}
Constants
SERVICE_NAME
Value: 'google.cloud.dataproc.v1.AutoscalingPolicyService'The name of the service.
SERVICE_ADDRESS
Value: 'dataproc.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.