Current section

Files

Jump to
google_api_dataproc lib google_api dataproc v1 model cluster.ex
Raw

lib/google_api/dataproc/v1/model/cluster.ex

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.
defmodule GoogleApi.Dataproc.V1.Model.Cluster do
@moduledoc """
Describes the identifying information, config, and status of a Dataproc cluster
## Attributes
* `clusterName` (*type:* `String.t`, *default:* `nil`) - 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.
* `clusterUuid` (*type:* `String.t`, *default:* `nil`) - Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
* `config` (*type:* `GoogleApi.Dataproc.V1.Model.ClusterConfig.t`, *default:* `nil`) - 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.
* `labels` (*type:* `map()`, *default:* `nil`) - 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.
* `metrics` (*type:* `GoogleApi.Dataproc.V1.Model.ClusterMetrics.t`, *default:* `nil`) - 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.
* `projectId` (*type:* `String.t`, *default:* `nil`) - Required. The Google Cloud Platform project ID that the cluster belongs to.
* `status` (*type:* `GoogleApi.Dataproc.V1.Model.ClusterStatus.t`, *default:* `nil`) - Output only. Cluster status.
* `statusHistory` (*type:* `list(GoogleApi.Dataproc.V1.Model.ClusterStatus.t)`, *default:* `nil`) - Output only. The previous cluster status.
* `virtualClusterConfig` (*type:* `GoogleApi.Dataproc.V1.Model.VirtualClusterConfig.t`, *default:* `nil`) - 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.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:clusterName => String.t() | nil,
:clusterUuid => String.t() | nil,
:config => GoogleApi.Dataproc.V1.Model.ClusterConfig.t() | nil,
:labels => map() | nil,
:metrics => GoogleApi.Dataproc.V1.Model.ClusterMetrics.t() | nil,
:projectId => String.t() | nil,
:status => GoogleApi.Dataproc.V1.Model.ClusterStatus.t() | nil,
:statusHistory => list(GoogleApi.Dataproc.V1.Model.ClusterStatus.t()) | nil,
:virtualClusterConfig => GoogleApi.Dataproc.V1.Model.VirtualClusterConfig.t() | nil
}
field(:clusterName)
field(:clusterUuid)
field(:config, as: GoogleApi.Dataproc.V1.Model.ClusterConfig)
field(:labels, type: :map)
field(:metrics, as: GoogleApi.Dataproc.V1.Model.ClusterMetrics)
field(:projectId)
field(:status, as: GoogleApi.Dataproc.V1.Model.ClusterStatus)
field(:statusHistory, as: GoogleApi.Dataproc.V1.Model.ClusterStatus, type: :list)
field(:virtualClusterConfig, as: GoogleApi.Dataproc.V1.Model.VirtualClusterConfig)
end
defimpl Poison.Decoder, for: GoogleApi.Dataproc.V1.Model.Cluster do
def decode(value, options) do
GoogleApi.Dataproc.V1.Model.Cluster.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Dataproc.V1.Model.Cluster do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end