com.google.cloud.dataproc.v1

Interface GceClusterConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GceClusterConfig, GceClusterConfig.Builder

public interface GceClusterConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(String key) The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
boolean	getInternalIpOnly() Optional.
Map<String,String>	getMetadata() Deprecated.
int	getMetadataCount() The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Map<String,String>	getMetadataMap() The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
String	getMetadataOrDefault(String key, String defaultValue) The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
String	getMetadataOrThrow(String key) The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
String	getNetworkUri() Optional.
com.google.protobuf.ByteString	getNetworkUriBytes() Optional.
String	getServiceAccount() Optional.
com.google.protobuf.ByteString	getServiceAccountBytes() Optional.
String	getServiceAccountScopes(int index) Optional.
com.google.protobuf.ByteString	getServiceAccountScopesBytes(int index) Optional.
int	getServiceAccountScopesCount() Optional.
List<String>	getServiceAccountScopesList() Optional.
String	getSubnetworkUri() Optional.
com.google.protobuf.ByteString	getSubnetworkUriBytes() Optional.
String	getTags(int index) The Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
com.google.protobuf.ByteString	getTagsBytes(int index) The Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
int	getTagsCount() The Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
List<String>	getTagsList() The Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
String	getZoneUri() Optional.
com.google.protobuf.ByteString	getZoneUriBytes() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getZoneUri

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

string zone_uri = 1;

getZoneUriBytes

com.google.protobuf.ByteString getZoneUriBytes()

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

string zone_uri = 1;

getNetworkUri

String 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](/compute/docs/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`
 

string network_uri = 2;

getNetworkUriBytes

com.google.protobuf.ByteString getNetworkUriBytes()

 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](/compute/docs/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`
 

string network_uri = 2;

getSubnetworkUri

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

string subnetwork_uri = 6;

getSubnetworkUriBytes

com.google.protobuf.ByteString getSubnetworkUriBytes()

 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`
 

string subnetwork_uri = 6;

getInternalIpOnly

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

bool internal_ip_only = 7;

getServiceAccount

String getServiceAccount()

 Optional. The service account of the instances. Defaults to the default
 Compute Engine service account. Custom service accounts need
 permissions equivalent to the following 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`
 

string service_account = 8;

getServiceAccountBytes

com.google.protobuf.ByteString getServiceAccountBytes()

 Optional. The service account of the instances. Defaults to the default
 Compute Engine service account. Custom service accounts need
 permissions equivalent to the following 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`
 

string service_account = 8;

getServiceAccountScopesList

List<String> getServiceAccountScopesList()

 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
 

repeated string service_account_scopes = 3;

getServiceAccountScopesCount

int getServiceAccountScopesCount()

 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
 

repeated string service_account_scopes = 3;

getServiceAccountScopes

String getServiceAccountScopes(int index)

 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
 

repeated string service_account_scopes = 3;

getServiceAccountScopesBytes

com.google.protobuf.ByteString getServiceAccountScopesBytes(int index)

 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
 

repeated string service_account_scopes = 3;

getTagsList

List<String> getTagsList()

 The Compute Engine tags to add to all instances (see
 [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 4;

getTagsCount

int getTagsCount()

 The Compute Engine tags to add to all instances (see
 [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 4;

getTags

String getTags(int index)

 The Compute Engine tags to add to all instances (see
 [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 4;

getTagsBytes

com.google.protobuf.ByteString getTagsBytes(int index)

 The Compute Engine tags to add to all instances (see
 [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 4;

getMetadataCount

int getMetadataCount()

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

containsMetadata

boolean containsMetadata(String key)

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

getMetadata

@Deprecated
Map<String,String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

getMetadataMap

Map<String,String> getMetadataMap()

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

getMetadataOrDefault

String getMetadataOrDefault(String key,
                            String defaultValue)

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

getMetadataOrThrow

String getMetadataOrThrow(String key)

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;