Class Google::Cloud::Dataproc::V1::ListClustersRequest (v0.8.0)

A request to list the clusters in a project.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

    field = value [AND [field = value]] ...

    where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

    Example filter:

    status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

    field = value [AND [field = value]] ...

    where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

    Example filter:

    status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

Returns
  • (::String) — Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

    field = value [AND [field = value]] ...

    where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

    Example filter:

    status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The standard List page size.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The standard List page size.
Returns
  • (::Integer) — Optional. The standard List page size.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. The standard List page token.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. The standard List page token.
Returns
  • (::String) — Optional. The standard List page token.

#project_id

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

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Required. The ID of the Google Cloud Platform project that the cluster belongs to.
Returns
  • (::String) — Required. The ID of the Google Cloud Platform project that 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.