Google Cloud Dataproc V1 Client - Class GceClusterConfig (3.2.2)

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

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ zone_uri
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

↳ 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]/regions/global/default * projects/[project_id]/regions/global/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/us-east1/subnetworks/sub0 * projects/[project_id]/regions/us-east1/subnetworks/sub0 * sub0

↳ internal_ip_only
bool

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.

↳ 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 tags to add to all instances (see Tagging instances ).

↳ metadata
array|Google\Protobuf\Internal\MapField

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

Generated from protobuf field string zone_uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
string

setZoneUri

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

Generated from protobuf field string zone_uri = 1 [(.google.api.field_behavior) = OPTIONAL];

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]/regions/global/default
  • projects/[project_id]/regions/global/default
  • default

Generated from protobuf field string network_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

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]/regions/global/default
  • projects/[project_id]/regions/global/default
  • default

Generated from protobuf field string network_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

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

Generated from protobuf field string subnetwork_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

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

Generated from protobuf field string subnetwork_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInternalIpOnly

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.

Generated from protobuf field bool internal_ip_only = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
bool

setInternalIpOnly

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.

Generated from protobuf field bool internal_ip_only = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getPrivateIpv6GoogleAccess

Optional. The type of IPv6 access for a cluster.

Generated from protobuf field .google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess private_ipv6_google_access = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

setPrivateIpv6GoogleAccess

Optional. The type of IPv6 access for a cluster.

Generated from protobuf field .google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess private_ipv6_google_access = 12 [(.google.api.field_behavior) = OPTIONAL];

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.

Generated from protobuf field string service_account = 8 [(.google.api.field_behavior) = OPTIONAL];

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.

Generated from protobuf field string service_account = 8 [(.google.api.field_behavior) = OPTIONAL];

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:

Generated from protobuf field repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

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:

Generated from protobuf field repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

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

getTags

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

Generated from protobuf field repeated string tags = 4;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setTags

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

Generated from protobuf field repeated string tags = 4;

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

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

Generated from protobuf field map<string, string> metadata = 5;

Returns
Type
Description
Google\Protobuf\Internal\MapField

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

Generated from protobuf field map<string, string> metadata = 5;

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

getReservationAffinity

Optional. Reservation Affinity for consuming Zonal reservation.

Generated from protobuf field .google.cloud.dataproc.v1.ReservationAffinity reservation_affinity = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

hasReservationAffinity

clearReservationAffinity

setReservationAffinity

Optional. Reservation Affinity for consuming Zonal reservation.

Generated from protobuf field .google.cloud.dataproc.v1.ReservationAffinity reservation_affinity = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
Returns
Type
Description
$this

getNodeGroupAffinity

Optional. Node Group Affinity for sole-tenant clusters.

Generated from protobuf field .google.cloud.dataproc.v1.NodeGroupAffinity node_group_affinity = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

hasNodeGroupAffinity

clearNodeGroupAffinity

setNodeGroupAffinity

Optional. Node Group Affinity for sole-tenant clusters.

Generated from protobuf field .google.cloud.dataproc.v1.NodeGroupAffinity node_group_affinity = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
Returns
Type
Description
$this

getShieldedInstanceConfig

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

Generated from protobuf field .google.cloud.dataproc.v1.ShieldedInstanceConfig shielded_instance_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

hasShieldedInstanceConfig

clearShieldedInstanceConfig

setShieldedInstanceConfig

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

Generated from protobuf field .google.cloud.dataproc.v1.ShieldedInstanceConfig shielded_instance_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
Returns
Type
Description
$this

getConfidentialInstanceConfig

Optional. Confidential Instance Config for clusters using Confidential VMs .

Generated from protobuf field .google.cloud.dataproc.v1.ConfidentialInstanceConfig confidential_instance_config = 15 [(.google.api.field_behavior) = OPTIONAL];

hasConfidentialInstanceConfig

clearConfidentialInstanceConfig

setConfidentialInstanceConfig

Optional. Confidential Instance Config for clusters using Confidential VMs .

Generated from protobuf field .google.cloud.dataproc.v1.ConfidentialInstanceConfig confidential_instance_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: