lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb in google-cloud-dataproc-0.3.0 vs lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb in google-cloud-dataproc-0.3.1
- old
+ new
@@ -34,12 +34,13 @@
# @return [Hash{String => String}]
# 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.
+ # 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.
# @!attribute [rw] status
# @return [Google::Cloud::Dataproc::V1::ClusterStatus]
# Output only. Cluster status.
# @!attribute [rw] status_history
# @return [Array<Google::Cloud::Dataproc::V1::ClusterStatus>]
@@ -50,12 +51,12 @@
# generates this value when it creates the cluster.
# @!attribute [rw] metrics
# @return [Google::Cloud::Dataproc::V1::ClusterMetrics]
# 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.
+ # **Beta Feature**: This report is available for testing purposes only. It
+ # may be changed before final release.
class Cluster; end
# The cluster config.
# @!attribute [rw] config_bucket
# @return [String]
@@ -87,13 +88,15 @@
# @!attribute [rw] initialization_actions
# @return [Array<Google::Cloud::Dataproc::V1::NodeInitializationAction>]
# Optional. Commands to execute on each node after config is
# completed. By default, executables are run on master and all worker nodes.
# You can test a node's `role` metadata to run an executable on
- # a master or worker node, as shown below using `curl` (you can also use `wget`):
+ # a master or worker node, as shown below using `curl` (you can also use
+ # `wget`):
#
- # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
+ # ROLE=$(curl -H Metadata-Flavor:Google
+ # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
# if [[ "${ROLE}" == 'Master' ]]; then
# ... master specific actions ...
# else
# ... worker specific actions ...
# fi
@@ -148,25 +151,26 @@
# * `projects/[project_id]/regions/us-east1/sub0`
# * `sub0`
# @!attribute [rw] internal_ip_only
# @return [true, false]
# Optional. If true, all instances in the cluster will only have internal IP
- # addresses. By default, clusters are not restricted to internal IP addresses,
- # and will have ephemeral external IP addresses assigned to each instance.
- # This `internal_ip_only` restriction can only be enabled for subnetwork
- # enabled networks, and all off-cluster dependencies must be configured to be
- # accessible without external IP addresses.
+ # addresses. By default, clusters are not restricted to internal IP
+ # addresses, and will have ephemeral external IP addresses assigned to each
+ # instance. This `internal_ip_only` restriction can only be enabled for
+ # subnetwork enabled networks, and all off-cluster dependencies must be
+ # configured to be accessible without external IP addresses.
# @!attribute [rw] service_account
# @return [String]
# Optional. The service account of the instances. Defaults to the default
# Compute Engine service account. Custom service accounts need
# permissions equivalent to the following IAM roles:
#
# * roles/logging.logWriter
# * roles/storage.objectAdmin
#
- # (see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts
+ # (see
+ # https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts
# for more information).
# Example: `[account_id]@[project_id].iam.gserviceaccount.com`
# @!attribute [rw] service_account_scopes
# @return [Array<String>]
# Optional. The URIs of service account scopes to be included in
@@ -188,11 +192,12 @@
# The Compute Engine tags to add to all instances (see
# [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
# @!attribute [rw] metadata
# @return [Hash{String => String}]
# The Compute Engine metadata entries to add to all instances (see
- # [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
+ # [Project and instance
+ # metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
class GceClusterConfig; end
# Optional. The config settings for Compute Engine resources in
# an instance group, such as a master or worker group.
# @!attribute [rw] num_instances
@@ -217,19 +222,21 @@
# * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`
# * `projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`
# * `n1-standard-2`
#
# **Auto Zone Exception**: If you are using the Cloud Dataproc
- # [Auto Zone Placement](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
+ # [Auto Zone
+ # Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
# feature, you must use the short name of the machine type
# resource, for example, `n1-standard-2`.
# @!attribute [rw] disk_config
# @return [Google::Cloud::Dataproc::V1::DiskConfig]
# Optional. Disk option config settings.
# @!attribute [rw] is_preemptible
# @return [true, false]
- # Optional. Specifies that this instance group contains preemptible instances.
+ # Optional. Specifies that this instance group contains preemptible
+ # instances.
# @!attribute [rw] managed_group_config
# @return [Google::Cloud::Dataproc::V1::ManagedGroupConfig]
# Output only. The config for Compute Engine Instance Group
# Manager that manages this group.
# This is only used for preemptible instance groups.
@@ -256,20 +263,22 @@
# of an instance. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/).
# @!attribute [rw] accelerator_type_uri
# @return [String]
# Full URL, partial URI, or short name of the accelerator type resource to
# expose to this instance. See
- # [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).
+ # [Compute Engine
+ # AcceleratorTypes](/compute/docs/reference/beta/acceleratorTypes).
#
# Examples:
#
# * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
# * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
# * `nvidia-tesla-k80`
#
# **Auto Zone Exception**: If you are using the Cloud Dataproc
- # [Auto Zone Placement](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
+ # [Auto Zone
+ # Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
# feature, you must use the short name of the accelerator type
# resource, for example, `nvidia-tesla-k80`.
# @!attribute [rw] accelerator_count
# @return [Integer]
# The number of the accelerator cards of this type exposed to this instance.
@@ -364,14 +373,16 @@
end
# Specifies the selection and config of software inside the cluster.
# @!attribute [rw] image_version
# @return [String]
- # Optional. The version of software inside the cluster. It must be one of the supported
- # [Cloud Dataproc Versions](https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions),
+ # Optional. The version of software inside the cluster. It must be one of the
+ # supported [Cloud Dataproc
+ # Versions](/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions),
# such as "1.2" (including a subminor version, such as "1.2.29"), or the
- # ["preview" version](https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions).
+ # ["preview"
+ # version](/dataproc/docs/concepts/versioning/dataproc-versions#other_versions).
# If unspecified, it defaults to the latest version.
# @!attribute [rw] properties
# @return [Hash{String => String}]
# Optional. The properties to set on daemon config files.
#
@@ -417,14 +428,15 @@
# @return [Google::Cloud::Dataproc::V1::Cluster]
# Required. The cluster to create.
# @!attribute [rw] request_id
# @return [String]
# Optional. A unique id used to identify the request. If the server
- # receives two {Google::Cloud::Dataproc::V1::CreateClusterRequest CreateClusterRequest} requests with the same
- # id, then the second request will be ignored and the
- # first {Google::Longrunning::Operation} created and stored in the backend
- # is returned.
+ # receives two
+ # {Google::Cloud::Dataproc::V1::CreateClusterRequest CreateClusterRequest}
+ # requests with the same id, then the second request will be ignored and the
+ # first {Google::Longrunning::Operation} created
+ # and stored in the backend is returned.
#
# It is recommended to always set this value to a
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
#
# The id must contain only letters (a-z, A-Z), numbers (0-9),
@@ -505,14 +517,15 @@
# </tbody>
# </table>
# @!attribute [rw] request_id
# @return [String]
# Optional. A unique id used to identify the request. If the server
- # receives two {Google::Cloud::Dataproc::V1::UpdateClusterRequest UpdateClusterRequest} requests with the same
- # id, then the second request will be ignored and the
- # first {Google::Longrunning::Operation} created and stored in the
- # backend is returned.
+ # receives two
+ # {Google::Cloud::Dataproc::V1::UpdateClusterRequest UpdateClusterRequest}
+ # requests with the same id, then the second request will be ignored and the
+ # first {Google::Longrunning::Operation} created
+ # and stored in the backend is returned.
#
# It is recommended to always set this value to a
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
#
# The id must contain only letters (a-z, A-Z), numbers (0-9),
@@ -535,13 +548,14 @@
# Optional. Specifying the `cluster_uuid` means the RPC should fail
# (with error NOT_FOUND) if cluster with specified UUID does not exist.
# @!attribute [rw] request_id
# @return [String]
# Optional. A unique id used to identify the request. If the server
- # receives two {Google::Cloud::Dataproc::V1::DeleteClusterRequest DeleteClusterRequest} requests with the same
- # id, then the second request will be ignored and the
- # first {Google::Longrunning::Operation} created and stored in the
- # backend is returned.
+ # receives two
+ # {Google::Cloud::Dataproc::V1::DeleteClusterRequest DeleteClusterRequest}
+ # requests with the same id, then the second request will be ignored and the
+ # first {Google::Longrunning::Operation} created
+ # and stored in the backend is returned.
#
# It is recommended to always set this value to a
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
#
# The id must contain only letters (a-z, A-Z), numbers (0-9),
\ No newline at end of file