Google Cloud Dataproc V1 Client - Class AutoscalingPolicy (3.8.1)

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

Describes an autoscaling policy for Dataproc cluster autoscaler.

Generated from protobuf message google.cloud.dataproc.v1.AutoscalingPolicy

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ id string

Required. The policy id. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.

↳ name string

Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. * For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} * For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}

↳ basic_algorithm Google\Cloud\Dataproc\V1\BasicAutoscalingAlgorithm
↳ worker_config Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig

Required. Describes how the autoscaler will operate for primary workers.

↳ secondary_worker_config Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig

Optional. Describes how the autoscaler will operate for secondary workers.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. The labels to associate with this autoscaling policy. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with an autoscaling policy.

getId

Required. The policy id.

The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.

Returns
TypeDescription
string

setId

Required. The policy id.

The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
  • For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
Returns
TypeDescription
string

setName

Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
  • For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBasicAlgorithm

Generated from protobuf field .google.cloud.dataproc.v1.BasicAutoscalingAlgorithm basic_algorithm = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Cloud\Dataproc\V1\BasicAutoscalingAlgorithm|null

hasBasicAlgorithm

setBasicAlgorithm

Generated from protobuf field .google.cloud.dataproc.v1.BasicAutoscalingAlgorithm basic_algorithm = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\Dataproc\V1\BasicAutoscalingAlgorithm
Returns
TypeDescription
$this

getWorkerConfig

Required. Describes how the autoscaler will operate for primary workers.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig|null

hasWorkerConfig

clearWorkerConfig

setWorkerConfig

Required. Describes how the autoscaler will operate for primary workers.

Parameter
NameDescription
var Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig
Returns
TypeDescription
$this

getSecondaryWorkerConfig

Optional. Describes how the autoscaler will operate for secondary workers.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig|null

hasSecondaryWorkerConfig

clearSecondaryWorkerConfig

setSecondaryWorkerConfig

Optional. Describes how the autoscaler will operate for secondary workers.

Parameter
NameDescription
var Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig
Returns
TypeDescription
$this

getLabels

Optional. The labels to associate with this autoscaling policy.

Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with an autoscaling policy.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels to associate with this autoscaling policy.

Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with an autoscaling policy.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getAlgorithm

Returns
TypeDescription
string