lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb in google-cloud-dataproc-0.2.1 vs lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb in google-cloud-dataproc-0.2.2
- old
+ new
@@ -86,12 +86,12 @@
# Optional. The config settings for software inside the cluster.
# @!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+):
+ # 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`):
#
# ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
# if [[ "${ROLE}" == 'Master' ]]; then
# ... master specific actions ...
# else
@@ -109,42 +109,42 @@
# corresponding Compute Engine region. On a get request, zone will
# always be present.
#
# A full URL, partial URI, or short name are valid. Examples:
#
- # * +https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]+
- # * +projects/[project_id]/zones/[zone]+
- # * +us-central1-f+
+ # * `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
# communications. Cannot be specified with subnetwork_uri. If neither
- # +network_uri+ nor +subnetwork_uri+ is specified, the "default" network of
+ # `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).
#
# A full URL, partial URI, or short name are valid. Examples:
#
- # * +https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default+
- # * +projects/[project_id]/regions/global/default+
- # * +default+
+ # * `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
# 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+
- # * +projects/[project_id]/regions/us-east1/sub0+
- # * +sub0+
+ # * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`
+ # * `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
+ # 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
@@ -154,11 +154,11 @@
# * 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+
+ # 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
# Compute Engine instances. The following base set of scopes is always
# included:
@@ -190,25 +190,25 @@
# 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
+ # `cluster_name`, `num_instances`, and the instance group if not set by user
# (recommended practice is to let Cloud Dataproc derive the name).
# @!attribute [rw] image_uri
# @return [String]
# Output-only. The Google Compute Engine image resource used for cluster
- # instances. Inferred from +SoftwareConfig.image_version+.
+ # instances. Inferred from `SoftwareConfig.image_version`.
# @!attribute [rw] machine_type_uri
# @return [String]
# Optional. The Google 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+
+ # * `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`
# @!attribute [rw] disk_config
# @return [Google::Cloud::Dataproc::V1::DiskConfig]
# Optional. Disk option config settings.
# @!attribute [rw] is_preemptible
# @return [true, false]
@@ -244,13 +244,13 @@
# 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)
#
# 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+
+ # * `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`
# @!attribute [rw] accelerator_count
# @return [Integer]
# The number of the accelerator cards of this type exposed to this instance.
class AcceleratorConfig; end
@@ -337,29 +337,29 @@
# 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
+ # regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the
# latest version (see [Cloud Dataproc Versioning](https://cloud.google.com/dataproc/versioning)).
# @!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
- # +core:fs.defaultFS+. The following are supported prefixes
+ # Property keys are specified in `prefix:property` format, such as
+ # `core:fs.defaultFS`. The following are supported prefixes
# and their mappings:
#
- # * capacity-scheduler: +capacity-scheduler.xml+
- # * core: +core-site.xml+
- # * distcp: +distcp-default.xml+
- # * hdfs: +hdfs-site.xml+
- # * hive: +hive-site.xml+
- # * mapred: +mapred-site.xml+
- # * pig: +pig.properties+
- # * spark: +spark-defaults.conf+
- # * yarn: +yarn-site.xml+
+ # * capacity-scheduler: `capacity-scheduler.xml`
+ # * core: `core-site.xml`
+ # * distcp: `distcp-default.xml`
+ # * hdfs: `hdfs-site.xml`
+ # * hive: `hive-site.xml`
+ # * mapred: `mapred-site.xml`
+ # * pig: `pig.properties`
+ # * spark: `spark-defaults.conf`
+ # * yarn: `yarn-site.xml`
#
# For more information, see
# [Cluster properties](https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
class SoftwareConfig; end
@@ -402,26 +402,26 @@
# @!attribute [rw] cluster
# @return [Google::Cloud::Dataproc::V1::Cluster]
# Required. The changes to the cluster.
# @!attribute [rw] update_mask
# @return [Google::Protobuf::FieldMask]
- # Required. Specifies the path, relative to +Cluster+, of
+ # 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
- # specified as +config.worker_config.num_instances+,
- # and the +PATCH+ request body would specify the new value, as follows:
+ # in a cluster to 5, the `update_mask` parameter would be
+ # specified as `config.worker_config.num_instances`,
+ # and the `PATCH` request body would specify the new value, as follows:
#
# {
# "config":{
# "workerConfig":{
# "numInstances":"5"
# }
# }
# }
# Similarly, to change the number of preemptible workers in a cluster to 5,
- # the +update_mask+ parameter would be
- # +config.secondary_worker_config.num_instances+, and the +PATCH+ request
+ # the `update_mask` parameter would be
+ # `config.secondary_worker_config.num_instances`, and the `PATCH` request
# body would be set as follows:
#
# {
# "config":{
# "secondaryWorkerConfig":{
@@ -492,19 +492,19 @@
# Optional. A filter constraining the clusters to list. Filters are
# case-sensitive and have the following syntax:
#
# field = value [AND [field = value]] ...
#
- # where **field** is one of +status.state+, +clusterName+, or +labels.[KEY]+,
- # and +[KEY]+ is a label key. **value** can be +*+ to match all values.
- # +status.state+ can be one of the following: +ACTIVE+, +INACTIVE+,
- # +CREATING+, +RUNNING+, +ERROR+, +DELETING+, or +UPDATING+. +ACTIVE+
- # contains the +CREATING+, +UPDATING+, and +RUNNING+ states. +INACTIVE+
- # contains the +DELETING+ and +ERROR+ states.
- # +clusterName+ is the name of the cluster provided at creation time.
- # Only the logical +AND+ operator is supported; space-separated items are
- # treated as having an implicit +AND+ operator.
+ # where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`,
+ # and `[KEY]` is a label key. **value** can be `*` to match all values.
+ # `status.state` can be one of the following: `ACTIVE`, `INACTIVE`,
+ # `CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE`
+ # contains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE`
+ # contains the `DELETING` and `ERROR` states.
+ # `clusterName` is the name of the cluster provided at creation time.
+ # Only the logical `AND` operator is supported; space-separated items are
+ # treated as having an implicit `AND` operator.
#
# Example filter:
#
# status.state = ACTIVE AND clusterName = mycluster
# AND labels.env = staging AND labels.starred = *
@@ -522,10 +522,10 @@
# 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
# results to fetch. To fetch additional results, provide this value as the
- # +page_token+ in a subsequent +ListClustersRequest+.
+ # `page_token` in a subsequent `ListClustersRequest`.
class ListClustersResponse; end
# A request to collect cluster diagnostic information.
# @!attribute [rw] project_id
# @return [String]
\ No newline at end of file