Class: Google::Cloud::Dataproc::V1beta2::GceClusterConfig

Inherits:

Object

• Object
• Google::Cloud::Dataproc::V1beta2::GceClusterConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dataproc/v1beta2/clusters.rb

Overview

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

Defined Under Namespace

Classes: MetadataEntry

Instance Attribute Summary

• #internal_ip_only ⇒ ::Boolean

  Optional.

• #metadata ⇒ ::Google::Protobuf::Map{::String => ::String}

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

• #network_uri ⇒ ::String

  Optional.

• #reservation_affinity ⇒ ::Google::Cloud::Dataproc::V1beta2::ReservationAffinity

  Optional.

• #service_account ⇒ ::String

  Optional.

• #service_account_scopes ⇒ ::Array<::String>

  Optional.

• #subnetwork_uri ⇒ ::String

  Optional.

• #tags ⇒ ::Array<::String>

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

• #zone_uri ⇒ ::String

  Optional.

Instance Attribute Details

#internal_ip_only ⇒ ::Boolean

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:

• (::Boolean) —

  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 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metadata ⇒ ::Google::Protobuf::Map{::String => ::String}

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

Returns:

• (::Google::Protobuf::Map{::String => ::String}) —

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

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#network_uri ⇒ ::String

Returns 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 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 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 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#reservation_affinity ⇒ ::Google::Cloud::Dataproc::V1beta2::ReservationAffinity

Returns Optional. Reservation Affinity for consuming Zonal reservation.

Returns:

• (::Google::Cloud::Dataproc::V1beta2::ReservationAffinity) —

  Optional. Reservation Affinity for consuming Zonal reservation.

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account ⇒ ::String

Returns Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.

If not specified, the Compute Engine default service account is used.

Returns:

• (::String) —

  Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.

  If not specified, the Compute Engine default service account is used.

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account_scopes ⇒ ::Array<::String>

Returns 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
• 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 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 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#subnetwork_uri ⇒ ::String

Returns 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/subnetworks/sub0
• projects/[project_id]/regions/us-east1/subnetworks/sub0
• sub0.

Returns:

• (::String) —

  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/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
  • sub0

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tags ⇒ ::Array<::String>

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

Returns:

• (::Array<::String>) —

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

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#zone_uri ⇒ ::String

Returns 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 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 Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global 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 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 318

class GceClusterConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end