Class: Google::Cloud::Dataproc::V1::Cluster

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

Overview

Describes the identifying information, config, and status of a Dataproc cluster

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_name ⇒ ::String

Returns Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused.

Returns:

  • (::String) —

    Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#cluster_uuid ⇒ ::String (readonly)

Returns Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

Returns:

  • (::String) —

    Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#config ⇒ ::Google::Cloud::Dataproc::V1::ClusterConfig

Returns Optional. The cluster config for a cluster of Compute Engine Instances. Note that Dataproc may set default values, and values may change when clusters are updated.

Exactly one of ClusterConfig or VirtualClusterConfig must be specified.

Returns:

  • (::Google::Cloud::Dataproc::V1::ClusterConfig) —

    Optional. The cluster config for a cluster of Compute Engine Instances. Note that Dataproc may set default values, and values may change when clusters are updated.

    Exactly one of ClusterConfig or VirtualClusterConfig must be specified.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metrics ⇒ ::Google::Cloud::Dataproc::V1::ClusterMetrics (readonly)

Returns Output only. Contains cluster daemon metrics such as HDFS and YARN stats.

Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Returns:

  • (::Google::Cloud::Dataproc::V1::ClusterMetrics) —

    Output only. Contains cluster daemon metrics such as HDFS and YARN stats.

    Beta Feature: This report is available for testing purposes only. It may be changed before final release.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#project_id ⇒ ::String

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

Returns:

  • (::String) —

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



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#status ⇒ ::Google::Cloud::Dataproc::V1::ClusterStatus (readonly)

Returns Output only. Cluster status.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#status_history ⇒ ::Array<::Google::Cloud::Dataproc::V1::ClusterStatus> (readonly)

Returns Output only. The previous cluster status.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#virtual_cluster_config ⇒ ::Google::Cloud::Dataproc::V1::VirtualClusterConfig

Returns Optional. The virtual cluster config is used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 78

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end