Google Cloud Dataproc V1 Client - Class ResizeNodeGroupRequest (2.0.0)

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

A request to resize a node group.

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

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

↳ size int

Required. The number of running instances for the node group to maintain. The group adds or removes instances to maintain the number of instances specified by this parameter.

↳ request_id string

Optional. A unique ID used to identify the request. If the server receives two ResizeNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned. Recommendation: Set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

↳ graceful_decommission_timeout Google\Protobuf\Duration

Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows the removal of nodes from the Compute Engine node group without interrupting jobs in progress. This timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration). Only supported on Dataproc image versions 1.2 and higher.

getName

Required. The name of the node group to resize.

Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

Returns
Type Description
string

setName

Required. The name of the node group to resize.

Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

Parameter
Name Description
var string
Returns
Type Description
$this

getSize

Required. The number of running instances for the node group to maintain.

The group adds or removes instances to maintain the number of instances specified by this parameter.

Returns
Type Description
int

setSize

Required. The number of running instances for the node group to maintain.

The group adds or removes instances to maintain the number of instances specified by this parameter.

Parameter
Name Description
var int
Returns
Type Description
$this

getRequestId

Optional. A unique ID used to identify the request. If the server receives two ResizeNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Returns
Type Description
string

setRequestId

Optional. A unique ID used to identify the request. If the server receives two ResizeNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getGracefulDecommissionTimeout

Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows the removal of nodes from the Compute Engine node group without interrupting jobs in progress. This timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration).

Only supported on Dataproc image versions 1.2 and higher.

Returns
Type Description
Google\Protobuf\Duration|null

hasGracefulDecommissionTimeout

clearGracefulDecommissionTimeout

setGracefulDecommissionTimeout

Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows the removal of nodes from the Compute Engine node group without interrupting jobs in progress. This timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration).

Only supported on Dataproc image versions 1.2 and higher.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

size int

Required. The number of running instances for the node group to maintain. The group adds or removes instances to maintain the number of instances specified by this parameter.

Returns
Type Description
Google\Cloud\Dataproc\V1\ResizeNodeGroupRequest