Package com.google.cloud.dataproc.v1

Interface ClusterOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Cluster, Cluster.Builder
    public interface ClusterOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getProjectId

        String getProjectId()
         Required. The Google Cloud Platform project ID that the cluster belongs to.
        string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The projectId.

      • getProjectIdBytes

        com.google.protobuf.ByteString getProjectIdBytes()
         Required. The Google Cloud Platform project ID that the cluster belongs to.
        string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for projectId.

      • getClusterName

        String getClusterName()
         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.
        string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The clusterName.

      • getClusterNameBytes

        com.google.protobuf.ByteString getClusterNameBytes()
         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.
        string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for clusterName.

      • hasConfig

        boolean hasConfig()
         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.
        .google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the config field is set.

      • getConfig

        ClusterConfig getConfig()
         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.
        .google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The config.

      • getConfigOrBuilder

        ClusterConfigOrBuilder getConfigOrBuilder()
         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.
        .google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL];

      • hasVirtualClusterConfig

        boolean hasVirtualClusterConfig()
         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][google.cloud.dataproc.v1.Cluster.config] or
 [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config]
 must be specified.
        .google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the virtualClusterConfig field is set.

      • getVirtualClusterConfig

        VirtualClusterConfig getVirtualClusterConfig()
         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][google.cloud.dataproc.v1.Cluster.config] or
 [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config]
 must be specified.
        .google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The virtualClusterConfig.

      • getVirtualClusterConfigOrBuilder

        VirtualClusterConfigOrBuilder getVirtualClusterConfigOrBuilder()
         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][google.cloud.dataproc.v1.Cluster.config] or
 [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config]
 must be specified.
        .google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsCount

        int getLabelsCount()
         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.
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • containsLabels

        boolean containsLabels​(String key)
         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.
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         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.
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         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.
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         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.
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • hasStatus

        boolean hasStatus()
         Output only. Cluster status.
        .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the status field is set.

      • getStatus

        ClusterStatus getStatus()
         Output only. Cluster status.
        .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The status.

      • getStatusOrBuilder

        ClusterStatusOrBuilder getStatusOrBuilder()
         Output only. Cluster status.
        .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStatusHistoryList

        List<ClusterStatus> getStatusHistoryList()
         Output only. The previous cluster status.
        repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStatusHistory

        ClusterStatus getStatusHistory​(int index)
         Output only. The previous cluster status.
        repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStatusHistoryCount

        int getStatusHistoryCount()
         Output only. The previous cluster status.
        repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStatusHistoryOrBuilderList

        List<? extends ClusterStatusOrBuilder> getStatusHistoryOrBuilderList()
         Output only. The previous cluster status.
        repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStatusHistoryOrBuilder

        ClusterStatusOrBuilder getStatusHistoryOrBuilder​(int index)
         Output only. The previous cluster status.
        repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getClusterUuid

        String getClusterUuid()
         Output only. A cluster UUID (Unique Universal Identifier). Dataproc
 generates this value when it creates the cluster.
        string cluster_uuid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The clusterUuid.

      • getClusterUuidBytes

        com.google.protobuf.ByteString getClusterUuidBytes()
         Output only. A cluster UUID (Unique Universal Identifier). Dataproc
 generates this value when it creates the cluster.
        string cluster_uuid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for clusterUuid.

      • hasMetrics

        boolean hasMetrics()
         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.
        .google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the metrics field is set.

      • getMetrics

        ClusterMetrics getMetrics()
         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.
        .google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The metrics.

      • getMetricsOrBuilder

        ClusterMetricsOrBuilder getMetricsOrBuilder()
         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.
        .google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];