Interface InstanceOrBuilder (1.28.0)

Version 1.28.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.1.1

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsOptions(String key)

public abstract boolean containsOptions(String key)

Map of additional options used to configure the behavior of Data Fusion instance.

map<string, string> options = 9;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAccelerators(int index)

public abstract Accelerator getAccelerators(int index)

List of accelerators enabled for this CDF instance.

repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

Parameter
Name	Description
index	int

Returns
Type	Description
Accelerator

getAcceleratorsCount()

public abstract int getAcceleratorsCount()

List of accelerators enabled for this CDF instance.

repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

Returns
Type	Description
int

getAcceleratorsList()

public abstract List<Accelerator> getAcceleratorsList()

List of accelerators enabled for this CDF instance.

repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

Returns
Type	Description
List<Accelerator>

getAcceleratorsOrBuilder(int index)

public abstract AcceleratorOrBuilder getAcceleratorsOrBuilder(int index)

List of accelerators enabled for this CDF instance.

repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

Parameter
Name	Description
index	int

Returns
Type	Description
AcceleratorOrBuilder

getAcceleratorsOrBuilderList()

public abstract List<? extends AcceleratorOrBuilder> getAcceleratorsOrBuilderList()

List of accelerators enabled for this CDF instance.

repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

Returns
Type	Description
List<? extends com.google.cloud.datafusion.v1beta1.AcceleratorOrBuilder>

getApiEndpoint()

public abstract String getApiEndpoint()

Output only. Endpoint on which the REST APIs is accessible.

string api_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The apiEndpoint.

getApiEndpointBytes()

public abstract ByteString getApiEndpointBytes()

Output only. Endpoint on which the REST APIs is accessible.

string api_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for apiEndpoint.

getAvailableVersion(int index)

public abstract Version getAvailableVersion(int index)

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

Parameter
Name	Description
index	int

Returns
Type	Description
Version

getAvailableVersionCount()

public abstract int getAvailableVersionCount()

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

Returns
Type	Description
int

getAvailableVersionList()

public abstract List<Version> getAvailableVersionList()

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

Returns
Type	Description
List<Version>

getAvailableVersionOrBuilder(int index)

public abstract VersionOrBuilder getAvailableVersionOrBuilder(int index)

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

Parameter
Name	Description
index	int

Returns
Type	Description
VersionOrBuilder

getAvailableVersionOrBuilderList()

public abstract List<? extends VersionOrBuilder> getAvailableVersionOrBuilderList()

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

Returns
Type	Description
List<? extends com.google.cloud.datafusion.v1beta1.VersionOrBuilder>

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time the instance was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the instance was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCryptoKeyConfig()

public abstract CryptoKeyConfig getCryptoKeyConfig()

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

.google.cloud.datafusion.v1beta1.CryptoKeyConfig crypto_key_config = 27;

Returns
Type	Description
CryptoKeyConfig	The cryptoKeyConfig.

getCryptoKeyConfigOrBuilder()

public abstract CryptoKeyConfigOrBuilder getCryptoKeyConfigOrBuilder()

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

.google.cloud.datafusion.v1beta1.CryptoKeyConfig crypto_key_config = 27;

Returns
Type	Description
CryptoKeyConfigOrBuilder

getDataprocServiceAccount()

public abstract String getDataprocServiceAccount()

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.

This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.

string dataproc_service_account = 25;

Returns
Type	Description
String	The dataprocServiceAccount.

getDataprocServiceAccountBytes()

public abstract ByteString getDataprocServiceAccountBytes()

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.

This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.

string dataproc_service_account = 25;

Returns
Type	Description
ByteString	The bytes for dataprocServiceAccount.

getDescription()

public abstract String getDescription()

A description of this instance.

string description = 2;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A description of this instance.

string description = 2;

Returns
Type	Description
ByteString	The bytes for description.

getDisabledReason(int index)

public abstract Instance.DisabledReason getDisabledReason(int index)

Output only. If the instance state is DISABLED, the reason for disabling the instance.

repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
Instance.DisabledReason	The disabledReason at the given index.

getDisabledReasonCount()

public abstract int getDisabledReasonCount()

Output only. If the instance state is DISABLED, the reason for disabling the instance.

repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The count of disabledReason.

getDisabledReasonList()

public abstract List<Instance.DisabledReason> getDisabledReasonList()

Output only. If the instance state is DISABLED, the reason for disabling the instance.

repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<DisabledReason>	A list containing the disabledReason.

getDisabledReasonValue(int index)

public abstract int getDisabledReasonValue(int index)

Output only. If the instance state is DISABLED, the reason for disabling the instance.

repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of disabledReason at the given index.

getDisabledReasonValueList()

public abstract List<Integer> getDisabledReasonValueList()

Output only. If the instance state is DISABLED, the reason for disabling the instance.

repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for disabledReason.

getDisplayName()

public abstract String getDisplayName()

Display name for an instance.

string display_name = 18;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Display name for an instance.

string display_name = 18;

Returns
Type	Description
ByteString	The bytes for displayName.

getEnableRbac()

public abstract boolean getEnableRbac()

Option to enable granular role-based access control.

bool enable_rbac = 26;

Returns
Type	Description
boolean	The enableRbac.

getEnableStackdriverLogging()

public abstract boolean getEnableStackdriverLogging()

Option to enable Stackdriver Logging.

bool enable_stackdriver_logging = 4;

Returns
Type	Description
boolean	The enableStackdriverLogging.

getEnableStackdriverMonitoring()

public abstract boolean getEnableStackdriverMonitoring()

Option to enable Stackdriver Monitoring.

bool enable_stackdriver_monitoring = 5;

Returns
Type	Description
boolean	The enableStackdriverMonitoring.

getGcsBucket()

public abstract String getGcsBucket()

Output only. Cloud Storage bucket generated by Data Fusion in the customer project.

string gcs_bucket = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The gcsBucket.

getGcsBucketBytes()

public abstract ByteString getGcsBucketBytes()

Output only. Cloud Storage bucket generated by Data Fusion in the customer project.

string gcs_bucket = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for gcsBucket.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.

map<string, string> labels = 8;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.

map<string, string> labels = 8;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.

map<string, string> labels = 8;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for name.

getNetworkConfig()

public abstract NetworkConfig getNetworkConfig()

Network configuration options. These are required when a private Data Fusion instance is to be created.

.google.cloud.datafusion.v1beta1.NetworkConfig network_config = 7;

Returns
Type	Description
NetworkConfig	The networkConfig.

getNetworkConfigOrBuilder()

public abstract NetworkConfigOrBuilder getNetworkConfigOrBuilder()

Network configuration options. These are required when a private Data Fusion instance is to be created.

.google.cloud.datafusion.v1beta1.NetworkConfig network_config = 7;

Returns
Type	Description
NetworkConfigOrBuilder

getOptions()

public abstract Map<String,String> getOptions()

Use #getOptionsMap() instead.

Returns
Type	Description
Map<String,String>

getOptionsCount()

public abstract int getOptionsCount()

Map of additional options used to configure the behavior of Data Fusion instance.

map<string, string> options = 9;

Returns
Type	Description
int

getOptionsMap()

public abstract Map<String,String> getOptionsMap()

Map of additional options used to configure the behavior of Data Fusion instance.

map<string, string> options = 9;

Returns
Type	Description
Map<String,String>

getOptionsOrDefault(String key, String defaultValue)

public abstract String getOptionsOrDefault(String key, String defaultValue)

Map of additional options used to configure the behavior of Data Fusion instance.

map<string, string> options = 9;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getOptionsOrThrow(String key)

public abstract String getOptionsOrThrow(String key)

Map of additional options used to configure the behavior of Data Fusion instance.

map<string, string> options = 9;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getP4ServiceAccount()

public abstract String getP4ServiceAccount()

Output only. P4 service account for the customer project.

string p4_service_account = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The p4ServiceAccount.

getP4ServiceAccountBytes()

public abstract ByteString getP4ServiceAccountBytes()

Output only. P4 service account for the customer project.

string p4_service_account = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for p4ServiceAccount.

getPrivateInstance()

public abstract boolean getPrivateInstance()

Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.

bool private_instance = 6;

Returns
Type	Description
boolean	The privateInstance.

getServiceAccount() (deprecated)

public abstract String getServiceAccount()

Deprecated. google.cloud.datafusion.v1beta1.Instance.service_account is deprecated. See google/cloud/datafusion/v1beta1/v1beta1.proto;l=392

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

string service_account = 17 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes() (deprecated)

public abstract ByteString getServiceAccountBytes()

Deprecated. google.cloud.datafusion.v1beta1.Instance.service_account is deprecated. See google/cloud/datafusion/v1beta1/v1beta1.proto;l=392

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

string service_account = 17 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for serviceAccount.

getServiceEndpoint()

public abstract String getServiceEndpoint()

Output only. Endpoint on which the Data Fusion UI is accessible.

string service_endpoint = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The serviceEndpoint.

getServiceEndpointBytes()

public abstract ByteString getServiceEndpointBytes()

Output only. Endpoint on which the Data Fusion UI is accessible.

string service_endpoint = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for serviceEndpoint.

getState()

public abstract Instance.State getState()

Output only. The current state of this Data Fusion instance.

.google.cloud.datafusion.v1beta1.Instance.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Instance.State	The state.

getStateMessage()

public abstract String getStateMessage()

Output only. Additional information about the current state of this Data Fusion instance if available.

string state_message = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The stateMessage.

getStateMessageBytes()

public abstract ByteString getStateMessageBytes()

Output only. Additional information about the current state of this Data Fusion instance if available.

string state_message = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for stateMessage.

getStateValue()

public abstract int getStateValue()

Output only. The current state of this Data Fusion instance.

.google.cloud.datafusion.v1beta1.Instance.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getTenantProjectId()

public abstract String getTenantProjectId()

Output only. The name of the tenant project.

string tenant_project_id = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The tenantProjectId.

getTenantProjectIdBytes()

public abstract ByteString getTenantProjectIdBytes()

Output only. The name of the tenant project.

string tenant_project_id = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for tenantProjectId.

getType()

public abstract Instance.Type getType()

Required. Instance type.

.google.cloud.datafusion.v1beta1.Instance.Type type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Instance.Type	The type.

getTypeValue()

public abstract int getTypeValue()

Required. Instance type.

.google.cloud.datafusion.v1beta1.Instance.Type type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for type.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time the instance was last updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the instance was last updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getVersion()

public abstract String getVersion()

Current version of Data Fusion.

string version = 16;

Returns
Type	Description
String	The version.

getVersionBytes()

public abstract ByteString getVersionBytes()

Current version of Data Fusion.

string version = 16;

Returns
Type	Description
ByteString	The bytes for version.

getZone()

public abstract String getZone()

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

string zone = 15;

Returns
Type	Description
String	The zone.

getZoneBytes()

public abstract ByteString getZoneBytes()

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

string zone = 15;

Returns
Type	Description
ByteString	The bytes for zone.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time the instance was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasCryptoKeyConfig()

public abstract boolean hasCryptoKeyConfig()

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

.google.cloud.datafusion.v1beta1.CryptoKeyConfig crypto_key_config = 27;

Returns
Type	Description
boolean	Whether the cryptoKeyConfig field is set.

hasNetworkConfig()

public abstract boolean hasNetworkConfig()

Network configuration options. These are required when a private Data Fusion instance is to be created.

.google.cloud.datafusion.v1beta1.NetworkConfig network_config = 7;

Returns
Type	Description
boolean	Whether the networkConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time the instance was last updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.