lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb in google-cloud-dataproc-0.2.2 vs lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb in google-cloud-dataproc-0.3.0

- old
+ new

@@ -1,6 +1,6 @@ -# Copyright 2018 Google LLC +# 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 # @@ -16,11 +16,11 @@ module Google module Cloud module Dataproc module V1 # Describes the identifying information, config, and status of - # a cluster of Google Compute Engine instances. + # a cluster of Compute Engine instances. # @!attribute [rw] project_id # @return [String] # Required. The Google Cloud Platform project ID that the cluster belongs to. # @!attribute [rw] cluster_name # @return [String] @@ -38,17 +38,17 @@ # 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. # @!attribute [rw] status # @return [Google::Cloud::Dataproc::V1::ClusterStatus] - # Output-only. Cluster status. + # Output only. Cluster status. # @!attribute [rw] status_history # @return [Array<Google::Cloud::Dataproc::V1::ClusterStatus>] - # Output-only. The previous cluster status. + # Output only. The previous cluster status. # @!attribute [rw] cluster_uuid # @return [String] - # Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc + # Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc # 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. # @@ -57,31 +57,31 @@ class Cluster; end # The cluster config. # @!attribute [rw] config_bucket # @return [String] - # Optional. A Google Cloud Storage staging bucket used for sharing generated + # Optional. A Cloud Storage staging bucket used for sharing generated # SSH keys and config. If you do not specify a staging bucket, Cloud # Dataproc will determine an appropriate Cloud Storage location (US, # ASIA, or EU) for your cluster's staging bucket according to the Google # Compute Engine zone where your cluster is deployed, and then it will create # and manage this project-level, per-location bucket for you. # @!attribute [rw] gce_cluster_config # @return [Google::Cloud::Dataproc::V1::GceClusterConfig] - # Required. The shared Google Compute Engine config settings for + # Required. The shared Compute Engine config settings for # all instances in a cluster. # @!attribute [rw] master_config # @return [Google::Cloud::Dataproc::V1::InstanceGroupConfig] - # Optional. The Google Compute Engine config settings for + # Optional. The Compute Engine config settings for # the master instance in a cluster. # @!attribute [rw] worker_config # @return [Google::Cloud::Dataproc::V1::InstanceGroupConfig] - # Optional. The Google Compute Engine config settings for + # Optional. The Compute Engine config settings for # worker instances in a cluster. # @!attribute [rw] secondary_worker_config # @return [Google::Cloud::Dataproc::V1::InstanceGroupConfig] - # Optional. The Google Compute Engine config settings for + # Optional. The Compute Engine config settings for # additional worker instances in a cluster. # @!attribute [rw] software_config # @return [Google::Cloud::Dataproc::V1::SoftwareConfig] # Optional. The config settings for software inside the cluster. # @!attribute [rw] initialization_actions @@ -95,17 +95,27 @@ # if [[ "${ROLE}" == 'Master' ]]; then # ... master specific actions ... # else # ... worker specific actions ... # fi + # @!attribute [rw] encryption_config + # @return [Google::Cloud::Dataproc::V1::EncryptionConfig] + # Optional. Encryption settings for the cluster. class ClusterConfig; end - # Common config settings for resources of Google Compute Engine cluster + # Encryption settings for the cluster. + # @!attribute [rw] gce_pd_kms_key_name + # @return [String] + # Optional. The Cloud KMS key name to use for PD disk encryption for all + # instances in the cluster. + class EncryptionConfig; end + + # Common config settings for resources of Compute Engine cluster # instances, applicable to all instances in the cluster. # @!attribute [rw] zone_uri # @return [String] - # Optional. The zone where the Google Compute Engine cluster will be located. + # Optional. The zone where the Compute Engine cluster will be located. # On a create request, it is required in the "global" region. If omitted # in a non-global Cloud Dataproc region, the service will pick a zone in the # corresponding Compute Engine region. On a get request, zone will # always be present. # @@ -114,11 +124,11 @@ # * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]` # * `projects/[project_id]/zones/[zone]` # * `us-central1-f` # @!attribute [rw] network_uri # @return [String] - # Optional. The Google Compute Engine network to be used for machine + # Optional. The Compute Engine network to be used for machine # communications. Cannot be specified with subnetwork_uri. If neither # `network_uri` nor `subnetwork_uri` is specified, the "default" network of # the project is used, if it exists. Cannot be a "Custom Subnet Network" (see # [Using Subnetworks](https://cloud.google.com/compute/docs/subnetworks) for more information). # @@ -127,11 +137,11 @@ # * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default` # * `projects/[project_id]/regions/global/default` # * `default` # @!attribute [rw] subnetwork_uri # @return [String] - # Optional. The Google Compute Engine subnetwork to be used for machine + # Optional. The Compute Engine subnetwork to be used for machine # communications. Cannot be specified with network_uri. # # A full URL, partial URI, or short name are valid. Examples: # # * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0` @@ -146,22 +156,22 @@ # 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 - # Google Compute Engine service account. Custom service accounts need - # permissions equivalent to the folloing IAM roles: + # 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 # 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 Google + # Optional. The URIs of service account scopes to be included in # Compute Engine instances. The following base set of scopes is always # included: # # * https://www.googleapis.com/auth/cloud.useraccounts.readonly # * https://www.googleapis.com/auth/devstorage.read_write @@ -173,90 +183,106 @@ # * https://www.googleapis.com/auth/bigtable.admin.table # * https://www.googleapis.com/auth/bigtable.data # * https://www.googleapis.com/auth/devstorage.full_control # @!attribute [rw] tags # @return [Array<String>] - # The Google Compute Engine tags to add to all instances (see + # 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 Google Compute Engine metadata entries to add to all instances (see + # 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)). class GceClusterConfig; end - # Optional. The config settings for Google Compute Engine resources in + # Optional. The config settings for Compute Engine resources in # an instance group, such as a master or worker group. # @!attribute [rw] num_instances # @return [Integer] # Optional. The number of VM instances in the instance group. # For master instance groups, must be set to 1. # @!attribute [rw] instance_names # @return [Array<String>] - # Optional. The list of instance names. Cloud Dataproc derives the names from - # `cluster_name`, `num_instances`, and the instance group if not set by user - # (recommended practice is to let Cloud Dataproc derive the name). + # Output only. The list of instance names. Cloud Dataproc derives the names + # from `cluster_name`, `num_instances`, and the instance group. # @!attribute [rw] image_uri # @return [String] - # Output-only. The Google Compute Engine image resource used for cluster - # instances. Inferred from `SoftwareConfig.image_version`. + # Optional. The Compute Engine image resource used for cluster + # instances. It can be specified or may be inferred from + # `SoftwareConfig.image_version`. # @!attribute [rw] machine_type_uri # @return [String] - # Optional. The Google Compute Engine machine type used for cluster instances. + # Optional. The Compute Engine machine type used for cluster instances. # # A full URL, partial URI, or short name are valid. Examples: # # * `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) + # 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. # @!attribute [rw] managed_group_config # @return [Google::Cloud::Dataproc::V1::ManagedGroupConfig] - # Output-only. The config for Google Compute Engine Instance Group + # Output only. The config for Compute Engine Instance Group # Manager that manages this group. # This is only used for preemptible instance groups. # @!attribute [rw] accelerators # @return [Array<Google::Cloud::Dataproc::V1::AcceleratorConfig>] - # Optional. The Google Compute Engine accelerator configuration for these + # Optional. The Compute Engine accelerator configuration for these # instances. # # **Beta Feature**: This feature is still under development. It may be # changed before final release. class InstanceGroupConfig; end # Specifies the resources used to actively manage an instance group. # @!attribute [rw] instance_template_name # @return [String] - # Output-only. The name of the Instance Template used for the Managed + # Output only. The name of the Instance Template used for the Managed # Instance Group. # @!attribute [rw] instance_group_manager_name # @return [String] - # Output-only. The name of the Instance Group Manager for this group. + # Output only. The name of the Instance Group Manager for this group. class ManagedGroupConfig; end # Specifies the type and number of accelerator cards attached to the instances - # of an instance group (see [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/)). + # 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 [Google Compute Engine AcceleratorTypes]( - # /compute/docs/reference/beta/acceleratorTypes) + # expose to this instance. See + # [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). # - # Examples + # 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) + # 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. class AcceleratorConfig; end # Specifies the config of disk options for a group of VM instances. + # @!attribute [rw] boot_disk_type + # @return [String] + # Optional. Type of the boot disk (default is "pd-standard"). + # Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or + # "pd-standard" (Persistent Disk Hard Disk Drive). # @!attribute [rw] boot_disk_size_gb # @return [Integer] # Optional. Size in GB of the boot disk (default is 500GB). # @!attribute [rw] num_local_ssds # @return [Integer] @@ -270,11 +296,11 @@ # Specifies an executable to run on a fully configured node and a # timeout period for executable completion. # @!attribute [rw] executable_file # @return [String] - # Required. Google Cloud Storage URI of executable file. + # Required. Cloud Storage URI of executable file. # @!attribute [rw] execution_timeout # @return [Google::Protobuf::Duration] # Optional. Amount of time executable has to complete. Default is # 10 minutes. Cluster creation fails with an explanatory error message (the # name of the executable that caused the error and the exceeded timeout @@ -282,20 +308,20 @@ class NodeInitializationAction; end # The status of a cluster and its instances. # @!attribute [rw] state # @return [Google::Cloud::Dataproc::V1::ClusterStatus::State] - # Output-only. The cluster's state. + # Output only. The cluster's state. # @!attribute [rw] detail # @return [String] - # Output-only. Optional details of cluster's state. + # Output only. Optional details of cluster's state. # @!attribute [rw] state_start_time # @return [Google::Protobuf::Timestamp] - # Output-only. Time when this state was entered. + # Output only. Time when this state was entered. # @!attribute [rw] substate # @return [Google::Cloud::Dataproc::V1::ClusterStatus::Substate] - # Output-only. Additional state information that includes + # Output only. Additional state information that includes # status reported by the agent. class ClusterStatus # The cluster state. module State # The cluster state is unknown. @@ -315,11 +341,13 @@ # The cluster is being updated. It continues to accept and process jobs. UPDATING = 5 end + # The cluster substate. module Substate + # The cluster substate is unknown. UNSPECIFIED = 0 # The cluster is known to be in an unhealthy state # (for example, critical daemons are not running or HDFS capacity is # exhausted). @@ -336,13 +364,15 @@ 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 match the - # regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the - # latest version (see [Cloud Dataproc Versioning](https://cloud.google.com/dataproc/versioning)). + # 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), + # 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). + # If unspecified, it defaults to the latest version. # @!attribute [rw] properties # @return [Hash{String => String}] # Optional. The properties to set on daemon config files. # # Property keys are specified in `prefix:property` format, such as @@ -384,10 +414,23 @@ # @return [String] # Required. The Cloud Dataproc region in which to handle the request. # @!attribute [rw] cluster # @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. + # + # 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), + # underscores (_), and hyphens (-). The maximum length is 40 characters. class CreateClusterRequest; end # A request to update a cluster. # @!attribute [rw] project_id # @return [String] @@ -400,10 +443,20 @@ # @return [String] # Required. The cluster name. # @!attribute [rw] cluster # @return [Google::Cloud::Dataproc::V1::Cluster] # Required. The changes to the cluster. + # @!attribute [rw] graceful_decommission_timeout + # @return [Google::Protobuf::Duration] + # Optional. Timeout for graceful YARN decomissioning. Graceful + # decommissioning allows removing nodes from the cluster without + # interrupting jobs in progress. Timeout specifies how long to wait for jobs + # in progress to finish before forcefully removing nodes (and potentially + # interrupting jobs). Default timeout is 0 (for forceful decommission), and + # the maximum allowed timeout is 1 day. + # + # Only supported on Dataproc image versions 1.2 and higher. # @!attribute [rw] update_mask # @return [Google::Protobuf::FieldMask] # Required. Specifies the path, relative to `Cluster`, of # the field to update. For example, to change the number of workers # in a cluster to 5, the `update_mask` parameter would be @@ -449,10 +502,23 @@ # <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> # <td>Resize secondary worker group</td> # </tr> # </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. + # + # 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), + # underscores (_), and hyphens (-). The maximum length is 40 characters. class UpdateClusterRequest; end # A request to delete a cluster. # @!attribute [rw] project_id # @return [String] @@ -462,10 +528,27 @@ # @return [String] # Required. The Cloud Dataproc region in which to handle the request. # @!attribute [rw] cluster_name # @return [String] # Required. The cluster name. + # @!attribute [rw] cluster_uuid + # @return [String] + # 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. + # + # 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), + # underscores (_), and hyphens (-). The maximum length is 40 characters. class DeleteClusterRequest; end # Request to get the resource representation for a cluster in a project. # @!attribute [rw] project_id # @return [String] @@ -517,14 +600,14 @@ class ListClustersRequest; end # The list of all clusters in a project. # @!attribute [rw] clusters # @return [Array<Google::Cloud::Dataproc::V1::Cluster>] - # Output-only. The clusters in the project. + # Output only. The clusters in the project. # @!attribute [rw] next_page_token # @return [String] - # Output-only. This token is included in the response if there are more + # Output only. This token is included in the response if there are more # results to fetch. To fetch additional results, provide this value as the # `page_token` in a subsequent `ListClustersRequest`. class ListClustersResponse; end # A request to collect cluster diagnostic information. @@ -541,10 +624,10 @@ class DiagnoseClusterRequest; end # The location of diagnostic output. # @!attribute [rw] output_uri # @return [String] - # Output-only. The Google Cloud Storage URI of the diagnostic output. + # Output only. The Cloud Storage URI of the diagnostic output. # The output report is a plain text file with a summary of collected # diagnostics. class DiagnoseClusterResults; end end end \ No newline at end of file