Google Cloud Dataproc V1 Client - Class GceClusterConfig (2.0.0)

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

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

Generated from protobuf message google.cloud.dataproc.v1.GceClusterConfig

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ zone_uri 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]
↳ network_uri 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
↳ subnetwork_uri 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
↳ internal_ip_only bool

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.
↳ private_ipv6_google_access int

Optional. The type of IPv6 access for a cluster.
↳ service_account 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.
↳ service_account_scopes array

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
↳ tags array

The Compute Engine network tags to add to all instances (see Tagging instances).
↳ metadata array|Google\Protobuf\Internal\MapField

Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata).
↳ reservation_affinity Google\Cloud\Dataproc\V1\ReservationAffinity

Optional. Reservation Affinity for consuming Zonal reservation.
↳ node_group_affinity Google\Cloud\Dataproc\V1\NodeGroupAffinity

Optional. Node Group Affinity for sole-tenant clusters.
↳ shielded_instance_config Google\Cloud\Dataproc\V1\ShieldedInstanceConfig

Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs.
↳ confidential_instance_config Google\Cloud\Dataproc\V1\ConfidentialInstanceConfig

Optional. Confidential Instance Config for clusters using Confidential VMs.

getZoneUri

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
Type Description
string

setZoneUri

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]
Parameter
Name Description
var string
Returns
Type Description
$this

getNetworkUri

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
Type Description
string

setNetworkUri

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
Parameter
Name Description
var string
Returns
Type Description
$this

getSubnetworkUri

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
Type Description
string

setSubnetworkUri

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
Parameter
Name Description
var string
Returns
Type Description
$this

getInternalIpOnly

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
Type Description
bool

hasInternalIpOnly

clearInternalIpOnly

setInternalIpOnly

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.
Parameter
Name Description
var bool
Returns
Type Description
$this

getPrivateIpv6GoogleAccess

Optional. The type of IPv6 access for a cluster.

Returns
Type Description
int

setPrivateIpv6GoogleAccess

Optional. The type of IPv6 access for a cluster.

Parameter
Name Description
var int
Returns
Type Description
$this

getServiceAccount

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
Type Description
string

setServiceAccount

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceAccountScopes

Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setServiceAccountScopes

Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

Parameter
Name Description
var string[]
Returns
Type Description
$this

getTags

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTags

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getMetadata

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setMetadata

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getReservationAffinity

Optional. Reservation Affinity for consuming Zonal reservation.

Returns
Type Description
Google\Cloud\Dataproc\V1\ReservationAffinity|null

hasReservationAffinity

clearReservationAffinity

setReservationAffinity

Optional. Reservation Affinity for consuming Zonal reservation.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\ReservationAffinity
Returns
Type Description
$this

getNodeGroupAffinity

Optional. Node Group Affinity for sole-tenant clusters.

Returns
Type Description
Google\Cloud\Dataproc\V1\NodeGroupAffinity|null

hasNodeGroupAffinity

clearNodeGroupAffinity

setNodeGroupAffinity

Optional. Node Group Affinity for sole-tenant clusters.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\NodeGroupAffinity
Returns
Type Description
$this

getShieldedInstanceConfig

Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs.

Returns
Type Description
Google\Cloud\Dataproc\V1\ShieldedInstanceConfig|null

hasShieldedInstanceConfig

clearShieldedInstanceConfig

setShieldedInstanceConfig

Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\ShieldedInstanceConfig
Returns
Type Description
$this

getConfidentialInstanceConfig

Optional. Confidential Instance Config for clusters using Confidential VMs.

Returns
Type Description
Google\Cloud\Dataproc\V1\ConfidentialInstanceConfig|null

hasConfidentialInstanceConfig

clearConfidentialInstanceConfig

setConfidentialInstanceConfig

Optional. Confidential Instance Config for clusters using Confidential VMs.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\ConfidentialInstanceConfig
Returns
Type Description
$this