Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::GceClusterConfig (v1.2.0)

Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::GceClusterConfig.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#confidential_instance_config

def confidential_instance_config() -> ::Google::Cloud::Dataproc::V1::ConfidentialInstanceConfig
Returns

#confidential_instance_config=

def confidential_instance_config=(value) -> ::Google::Cloud::Dataproc::V1::ConfidentialInstanceConfig
Parameter
Returns

#internal_ip_only

def internal_ip_only() -> ::Boolean
Returns
  • (::Boolean) —

    Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.

    When set to true:

    • All cluster VMs have internal IP addresses.
    • Google Private Access must be enabled to access Dataproc and other Google Cloud APIs.
    • Off-cluster dependencies must be configured to be accessible without external IP addresses.

    When set to false:

    • Cluster VMs are not restricted to internal IP addresses.
    • Ephemeral external IP addresses are assigned to each cluster VM.

#internal_ip_only=

def internal_ip_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.

    When set to true:

    • All cluster VMs have internal IP addresses.
    • Google Private Access must be enabled to access Dataproc and other Google Cloud APIs.
    • Off-cluster dependencies must be configured to be accessible without external IP addresses.

    When set to false:

    • Cluster VMs are not restricted to internal IP addresses.
    • Ephemeral external IP addresses are assigned to each cluster VM.
Returns
  • (::Boolean) —

    Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.

    When set to true:

    • All cluster VMs have internal IP addresses.
    • Google Private Access must be enabled to access Dataproc and other Google Cloud APIs.
    • Off-cluster dependencies must be configured to be accessible without external IP addresses.

    When set to false:

    • Cluster VMs are not restricted to internal IP addresses.
    • Ephemeral external IP addresses are assigned to each cluster VM.

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata).

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata).
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata).

#network_uri

def network_uri() -> ::String
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]/global/networks/default
    • projects/[project_id]/global/networks/default
    • default

#network_uri=

def network_uri=(value) -> ::String
Parameter
  • value (::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]/global/networks/default
    • projects/[project_id]/global/networks/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]/global/networks/default
    • projects/[project_id]/global/networks/default
    • default

#node_group_affinity

def node_group_affinity() -> ::Google::Cloud::Dataproc::V1::NodeGroupAffinity
Returns

#node_group_affinity=

def node_group_affinity=(value) -> ::Google::Cloud::Dataproc::V1::NodeGroupAffinity
Parameter
Returns

#private_ipv6_google_access

def private_ipv6_google_access() -> ::Google::Cloud::Dataproc::V1::GceClusterConfig::PrivateIpv6GoogleAccess
Returns

#private_ipv6_google_access=

def private_ipv6_google_access=(value) -> ::Google::Cloud::Dataproc::V1::GceClusterConfig::PrivateIpv6GoogleAccess
Parameter
Returns

#reservation_affinity

def reservation_affinity() -> ::Google::Cloud::Dataproc::V1::ReservationAffinity
Returns

#reservation_affinity=

def reservation_affinity=(value) -> ::Google::Cloud::Dataproc::V1::ReservationAffinity
Parameter
Returns

#service_account

def service_account() -> ::String
Returns

#service_account=

def service_account=(value) -> ::String
Parameter
Returns

#service_account_scopes

def service_account_scopes() -> ::Array<::String>
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

#service_account_scopes=

def service_account_scopes=(value) -> ::Array<::String>
Parameter
  • value (::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
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

#shielded_instance_config

def shielded_instance_config() -> ::Google::Cloud::Dataproc::V1::ShieldedInstanceConfig
Returns

#shielded_instance_config=

def shielded_instance_config=(value) -> ::Google::Cloud::Dataproc::V1::ShieldedInstanceConfig
Parameter
Returns

#subnetwork_uri

def subnetwork_uri() -> ::String
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/[region]/subnetworks/sub0
    • projects/[project_id]/regions/[region]/subnetworks/sub0
    • sub0

#subnetwork_uri=

def subnetwork_uri=(value) -> ::String
Parameter
  • value (::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/[region]/subnetworks/sub0
    • projects/[project_id]/regions/[region]/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/[region]/subnetworks/sub0
    • projects/[project_id]/regions/[region]/subnetworks/sub0
    • sub0

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — The Compute Engine network tags to add to all instances (see Tagging instances).

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The Compute Engine network tags to add to all instances (see Tagging instances).
Returns
  • (::Array<::String>) — The Compute Engine network tags to add to all instances (see Tagging instances).

#zone_uri

def zone_uri() -> ::String
Returns
  • (::String) —

    Optional. The Compute Engine zone where the Dataproc cluster will be located. If omitted, the service will pick a zone in the cluster's 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]
    • [zone]

#zone_uri=

def zone_uri=(value) -> ::String
Parameter
  • value (::String) —

    Optional. The Compute Engine zone where the Dataproc cluster will be located. If omitted, the service will pick a zone in the cluster's 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]
    • [zone]
Returns
  • (::String) —

    Optional. The Compute Engine zone where the Dataproc cluster will be located. If omitted, the service will pick a zone in the cluster's 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]
    • [zone]