Class: Google::Cloud::Dataproc::V1::ListClustersRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataproc/v1/clusters.rb

Overview

A request to list the clusters in a project.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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 = *



1514
1515
1516
1517
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1514

class ListClustersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. The standard List page size.

Returns:

  • (::Integer) —

    Optional. The standard List page size.



1514
1515
1516
1517
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1514

class ListClustersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. The standard List page token.

Returns:

  • (::String) —

    Optional. The standard List page token.



1514
1515
1516
1517
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1514

class ListClustersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#project_id ⇒ ::String

Returns 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.



1514
1515
1516
1517
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1514

class ListClustersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#region ⇒ ::String

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

Returns:

  • (::String) —

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



1514
1515
1516
1517
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1514

class ListClustersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end