Class: Google::Cloud::Dataproc::V1::GceClusterConfig

Inherits:

Object

• Object
• Google::Cloud::Dataproc::V1::GceClusterConfig

Defined in:

lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb

Overview

Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.

Instance Attribute Summary

• #internal_ip_only ⇒ true, false

  Optional.

• #metadata ⇒ Hash{String => String}

  The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata).

• #network_uri ⇒ String

  Optional.

• #service_account ⇒ String

  Optional.

• #service_account_scopes ⇒ Array<String>

  Optional.

• #subnetwork_uri ⇒ String

  Optional.

• #tags ⇒ Array<String>

  The Google Compute Engine tags to add to all instances (see Tagging instances).

• #zone_uri ⇒ String

  Optional.

Instance Attribute Details

#internal_ip_only ⇒ true, false

Returns 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.

Returns:

• (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.

# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 183

class GceClusterConfig; end

#metadata ⇒ Hash{String => String}

Returns The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata).

Returns:

• (Hash{String => String}) —

  The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata).

# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 183

class GceClusterConfig; end

#network_uri ⇒ String

Returns 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 the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using 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+

Returns:

• (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 the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using 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+

# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 183

class GceClusterConfig; end

#service_account ⇒ String

Returns 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:

• 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+

Returns:

• (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:

  • 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+

# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 183

class GceClusterConfig; end

#service_account_scopes ⇒ Array<String>

Returns Optional. The URIs of service account scopes to be included in Google 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
• https://www.googleapis.com/auth/logging.write

If no scopes are specified, the following defaults are also provided:

• https://www.googleapis.com/auth/bigquery
• https://www.googleapis.com/auth/bigtable.admin.table
• https://www.googleapis.com/auth/bigtable.data
• https://www.googleapis.com/auth/devstorage.full_control

Returns:

• (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:

  • https://www.googleapis.com/auth/cloud.useraccounts.readonly
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/logging.write

  If no scopes are specified, the following defaults are also provided:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/bigtable.admin.table
  • https://www.googleapis.com/auth/bigtable.data
  • https://www.googleapis.com/auth/devstorage.full_control

# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 183

class GceClusterConfig; end

#subnetwork_uri ⇒ String

Returns 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+

Returns:

• (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+

# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 183

class GceClusterConfig; end

#tags ⇒ Array<String>

Returns The Google Compute Engine tags to add to all instances (see Tagging instances).

Returns:

• (Array<String>) —

  The Google Compute Engine tags to add to all instances (see Tagging instances).

# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 183

class GceClusterConfig; end

#zone_uri ⇒ String

Returns Optional. The zone where the Google 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.

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+

Returns:

• (String) —

  Optional. The zone where the Google 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.

  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+

# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 183

class GceClusterConfig; end