Google Cloud Dataproc V1 Client - Class StopClusterRequest (3.14.0)

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

A request to stop a cluster.

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

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ project_id string

Required. The ID of the Google Cloud Platform project the cluster belongs to.
↳ region string

Required. The Dataproc region in which to handle the request.
↳ cluster_name string

Required. The cluster name.
↳ cluster_uuid string

Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.
↳ request_id string

Optional. A unique ID used to identify the request. If the server receives two StopClusterRequests with the same id, then the second request will be 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.

getProjectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

Returns
Type Description
string

setProjectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

Required. The Dataproc region in which to handle the request.

Returns
Type Description
string

setRegion

Required. The Dataproc region in which to handle the request.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterName

Required. The cluster name.

Returns
Type Description
string

setClusterName

Required. The cluster name.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterUuid

Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.

Returns
Type Description
string

setClusterUuid

Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. A unique ID used to identify the request. If the server receives two StopClusterRequests with the same id, then the second request will be 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 StopClusterRequests with the same id, then the second request will be 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