/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataproc/v1/clusters.proto
package com.google.cloud.dataproc.v1;
public interface GceClusterConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.GceClusterConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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]`
*
*
* string zone_uri = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The zoneUri.
*/
java.lang.String 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]`
*
*
* string zone_uri = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for zoneUri.
*/
com.google.protobuf.ByteString getZoneUriBytes();
/**
*
*
*
* 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](https://cloud.google.com/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]/global/networks/default`
* * `projects/[project_id]/global/networks/default`
* * `default`
*
*
* string network_uri = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The networkUri.
*/
java.lang.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](https://cloud.google.com/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]/global/networks/default`
* * `projects/[project_id]/global/networks/default`
* * `default`
*
*
* string network_uri = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for networkUri.
*/
com.google.protobuf.ByteString getNetworkUriBytes();
/**
*
*
*
* 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`
*
*
* string subnetwork_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The subnetworkUri.
*/
java.lang.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/[region]/subnetworks/sub0`
* * `projects/[project_id]/regions/[region]/subnetworks/sub0`
* * `sub0`
*
*
* string subnetwork_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for subnetworkUri.
*/
com.google.protobuf.ByteString getSubnetworkUriBytes();
/**
*
*
*
* 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.
*
*
* optional bool internal_ip_only = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return Whether the internalIpOnly field is set.
*/
boolean hasInternalIpOnly();
/**
*
*
*
* 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.
*
*
* optional bool internal_ip_only = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The internalIpOnly.
*/
boolean getInternalIpOnly();
/**
*
*
*
* Optional. The type of IPv6 access for a cluster.
*
*
*
* .google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess private_ipv6_google_access = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enum numeric value on the wire for privateIpv6GoogleAccess.
*/
int getPrivateIpv6GoogleAccessValue();
/**
*
*
*
* Optional. The type of IPv6 access for a cluster.
*
*
*
* .google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess private_ipv6_google_access = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The privateIpv6GoogleAccess.
*/
com.google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess
getPrivateIpv6GoogleAccess();
/**
*
*
*
* Optional. The [Dataproc service
* account](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc)
* (also see [VM Data Plane
* identity](https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity))
* used by Dataproc cluster VM instances to access Google Cloud Platform
* services.
* If not specified, the
* [Compute Engine default service
* account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
* is used.
*
*
* string service_account = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The serviceAccount.
*/
java.lang.String getServiceAccount();
/**
*
*
*
* Optional. The [Dataproc service
* account](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc)
* (also see [VM Data Plane
* identity](https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity))
* used by Dataproc cluster VM instances to access Google Cloud Platform
* services.
* If not specified, the
* [Compute Engine default service
* account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
* is used.
*
*
* string service_account = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for serviceAccount.
*/
com.google.protobuf.ByteString getServiceAccountBytes();
/**
*
*
*
* 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 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return A list containing the serviceAccountScopes.
*/
java.util.List 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 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The count of serviceAccountScopes.
*/
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 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @param index The index of the element to return.
* @return The serviceAccountScopes at the given index.
*/
java.lang.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 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @param index The index of the value to return.
* @return The bytes of the serviceAccountScopes at the given index.
*/
com.google.protobuf.ByteString getServiceAccountScopesBytes(int index);
/**
*
*
*
* The Compute Engine tags to add to all instances (see [Tagging
* instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
*
*
* repeated string tags = 4;
*
* @return A list containing the tags.
*/
java.util.List getTagsList();
/**
*
*
*
* The Compute Engine tags to add to all instances (see [Tagging
* instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
*
*
* repeated string tags = 4;
*
* @return The count of tags.
*/
int getTagsCount();
/**
*
*
*
* The Compute Engine tags to add to all instances (see [Tagging
* instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
*
*
* repeated string tags = 4;
*
* @param index The index of the element to return.
* @return The tags at the given index.
*/
java.lang.String getTags(int index);
/**
*
*
*
* The Compute Engine tags to add to all instances (see [Tagging
* instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
*
*
* repeated string tags = 4;
*
* @param index The index of the value to return.
* @return The bytes of the tags at the given index.
*/
com.google.protobuf.ByteString getTagsBytes(int index);
/**
*
*
*
* 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;
*/
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;
*/
boolean containsMetadata(java.lang.String key);
/** Use {@link #getMetadataMap()} instead. */
@java.lang.Deprecated
java.util.Map getMetadata();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getMetadataOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getMetadataOrThrow(java.lang.String key);
/**
*
*
*
* Optional. Reservation Affinity for consuming Zonal reservation.
*
*
*
* .google.cloud.dataproc.v1.ReservationAffinity reservation_affinity = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the reservationAffinity field is set.
*/
boolean hasReservationAffinity();
/**
*
*
*
* Optional. Reservation Affinity for consuming Zonal reservation.
*
*
*
* .google.cloud.dataproc.v1.ReservationAffinity reservation_affinity = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The reservationAffinity.
*/
com.google.cloud.dataproc.v1.ReservationAffinity getReservationAffinity();
/**
*
*
*
* Optional. Reservation Affinity for consuming Zonal reservation.
*
*
*
* .google.cloud.dataproc.v1.ReservationAffinity reservation_affinity = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.ReservationAffinityOrBuilder getReservationAffinityOrBuilder();
/**
*
*
*
* Optional. Node Group Affinity for sole-tenant clusters.
*
*
*
* .google.cloud.dataproc.v1.NodeGroupAffinity node_group_affinity = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the nodeGroupAffinity field is set.
*/
boolean hasNodeGroupAffinity();
/**
*
*
*
* Optional. Node Group Affinity for sole-tenant clusters.
*
*
*
* .google.cloud.dataproc.v1.NodeGroupAffinity node_group_affinity = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The nodeGroupAffinity.
*/
com.google.cloud.dataproc.v1.NodeGroupAffinity getNodeGroupAffinity();
/**
*
*
*
* Optional. Node Group Affinity for sole-tenant clusters.
*
*
*
* .google.cloud.dataproc.v1.NodeGroupAffinity node_group_affinity = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.NodeGroupAffinityOrBuilder getNodeGroupAffinityOrBuilder();
/**
*
*
*
* Optional. Shielded Instance Config for clusters using [Compute Engine
* Shielded
* VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm).
*
*
*
* .google.cloud.dataproc.v1.ShieldedInstanceConfig shielded_instance_config = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the shieldedInstanceConfig field is set.
*/
boolean hasShieldedInstanceConfig();
/**
*
*
*
* Optional. Shielded Instance Config for clusters using [Compute Engine
* Shielded
* VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm).
*
*
*
* .google.cloud.dataproc.v1.ShieldedInstanceConfig shielded_instance_config = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The shieldedInstanceConfig.
*/
com.google.cloud.dataproc.v1.ShieldedInstanceConfig getShieldedInstanceConfig();
/**
*
*
*
* Optional. Shielded Instance Config for clusters using [Compute Engine
* Shielded
* VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm).
*
*
*
* .google.cloud.dataproc.v1.ShieldedInstanceConfig shielded_instance_config = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder();
/**
*
*
*
* Optional. Confidential Instance Config for clusters using [Confidential
* VMs](https://cloud.google.com/compute/confidential-vm/docs).
*
*
*
* .google.cloud.dataproc.v1.ConfidentialInstanceConfig confidential_instance_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the confidentialInstanceConfig field is set.
*/
boolean hasConfidentialInstanceConfig();
/**
*
*
*
* Optional. Confidential Instance Config for clusters using [Confidential
* VMs](https://cloud.google.com/compute/confidential-vm/docs).
*
*
*
* .google.cloud.dataproc.v1.ConfidentialInstanceConfig confidential_instance_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The confidentialInstanceConfig.
*/
com.google.cloud.dataproc.v1.ConfidentialInstanceConfig getConfidentialInstanceConfig();
/**
*
*
*
* Optional. Confidential Instance Config for clusters using [Confidential
* VMs](https://cloud.google.com/compute/confidential-vm/docs).
*
*
*
* .google.cloud.dataproc.v1.ConfidentialInstanceConfig confidential_instance_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.ConfidentialInstanceConfigOrBuilder
getConfidentialInstanceConfigOrBuilder();
}