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
Methods
__construct
Constructor.
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 StopClusterRequest s 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.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
string
setProjectId
Required. The ID of the Google Cloud Platform project the cluster belongs to.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getRegion
Required. The Dataproc region in which to handle the request.
Generated from protobuf field string region = 2 [(.google.api.field_behavior) = REQUIRED];
string
setRegion
Required. The Dataproc region in which to handle the request.
Generated from protobuf field string region = 2 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getClusterName
Required. The cluster name.
Generated from protobuf field string cluster_name = 3 [(.google.api.field_behavior) = REQUIRED];
string
setClusterName
Required. The cluster name.
Generated from protobuf field string cluster_name = 3 [(.google.api.field_behavior) = REQUIRED];
var
string
$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.
Generated from protobuf field string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getRequestId
Optional. A unique ID used to identify the request. If the server receives two StopClusterRequest s 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.
Generated from protobuf field string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];
string
setRequestId
Optional. A unique ID used to identify the request. If the server receives two StopClusterRequest s 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.
Generated from protobuf field string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
