Show / Hide Table of Contents

Class Cluster

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

Inheritance
object
Cluster
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dataproc.v1.Data
Assembly: Google.Apis.Dataproc.v1.dll
Syntax
public class Cluster : IDirectResponseSchema

Properties

ClusterName

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.

Declaration
[JsonProperty("clusterName")]
public virtual string ClusterName { get; set; }
Property Value
Type Description
string

ClusterUuid

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

Declaration
[JsonProperty("clusterUuid")]
public virtual string ClusterUuid { get; set; }
Property Value
Type Description
string

Config

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.

Declaration
[JsonProperty("config")]
public virtual ClusterConfig Config { get; set; }
Property Value
Type Description
ClusterConfig

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Labels

Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Metrics

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.

Declaration
[JsonProperty("metrics")]
public virtual ClusterMetrics Metrics { get; set; }
Property Value
Type Description
ClusterMetrics

ProjectId

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

Declaration
[JsonProperty("projectId")]
public virtual string ProjectId { get; set; }
Property Value
Type Description
string

Status

Output only. Cluster status.

Declaration
[JsonProperty("status")]
public virtual ClusterStatus Status { get; set; }
Property Value
Type Description
ClusterStatus

StatusHistory

Output only. The previous cluster status.

Declaration
[JsonProperty("statusHistory")]
public virtual IList<ClusterStatus> StatusHistory { get; set; }
Property Value
Type Description
IList<ClusterStatus>

VirtualClusterConfig

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 (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified.

Declaration
[JsonProperty("virtualClusterConfig")]
public virtual VirtualClusterConfig VirtualClusterConfig { get; set; }
Property Value
Type Description
VirtualClusterConfig

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX