Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::StopClusterRequest (v0.12.0)

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

A request to stop a cluster.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cluster_name

def cluster_name() -> ::String
Returns
  • (::String) — Required. The cluster name.

#cluster_name=

def cluster_name=(value) -> ::String
Parameter
  • value (::String) — Required. The cluster name.
Returns
  • (::String) — Required. The cluster name.

#cluster_uuid

def cluster_uuid() -> ::String
Returns
  • (::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.

#cluster_uuid=

def cluster_uuid=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#project_id

def project_id() -> ::String
Returns
  • (::String) — Required. The ID of the Google Cloud Platform project the cluster belongs to.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Required. The ID of the Google Cloud Platform project the cluster belongs to.
Returns
  • (::String) — Required. The ID of the Google Cloud Platform project the cluster belongs to.

#region

def region() -> ::String
Returns
  • (::String) — Required. The Dataproc region in which to handle the request.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — Required. The Dataproc region in which to handle the request.
Returns
  • (::String) — Required. The Dataproc region in which to handle the request.

#request_id

def request_id() -> ::String
Returns
  • (::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.

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.