Interface InstanceOrBuilder (1.4.0)

publicinterface InstanceOrBuilderextendsMessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

publicabstractbooleancontainsLabels(Stringkey)

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

containsOptions(String key)

publicabstractbooleancontainsOptions(Stringkey)

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

getAccelerators(int index)

publicabstractAcceleratorgetAccelerators(intindex)

List of accelerators enabled for this CDF instance.

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

Parameter
Name Description
index int
Returns
Type Description

getAcceleratorsCount()

publicabstractintgetAcceleratorsCount()

List of accelerators enabled for this CDF instance.

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

Returns
Type Description
int

getAcceleratorsList()

publicabstractList<Accelerator>getAcceleratorsList()

List of accelerators enabled for this CDF instance.

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

Returns
Type Description

getAcceleratorsOrBuilder(int index)

publicabstractAcceleratorOrBuildergetAcceleratorsOrBuilder(intindex)

List of accelerators enabled for this CDF instance.

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

Parameter
Name Description
index int
Returns
Type Description

getAcceleratorsOrBuilderList()

publicabstractList<?extendsAcceleratorOrBuilder>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()

publicabstractStringgetApiEndpoint()

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

publicabstractByteStringgetApiEndpointBytes()

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)

publicabstractVersiongetAvailableVersion(intindex)

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

getAvailableVersionCount()

publicabstractintgetAvailableVersionCount()

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

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

getAvailableVersionOrBuilder(int index)

publicabstractVersionOrBuildergetAvailableVersionOrBuilder(intindex)

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

getAvailableVersionOrBuilderList()

publicabstractList<?extendsVersionOrBuilder>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()

publicabstractTimestampgetCreateTime()

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

publicabstractTimestampOrBuildergetCreateTimeOrBuilder()

Output only. The time the instance was created.

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

Returns
Type Description

getCryptoKeyConfig()

publicabstractCryptoKeyConfiggetCryptoKeyConfig()

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

publicabstractCryptoKeyConfigOrBuildergetCryptoKeyConfigOrBuilder()

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

getDataprocServiceAccount()

publicabstractStringgetDataprocServiceAccount()

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

publicabstractByteStringgetDataprocServiceAccountBytes()

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

publicabstractStringgetDescription()

A description of this instance.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

publicabstractByteStringgetDescriptionBytes()

A description of this instance.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDisabledReason(int index)

publicabstractInstance.DisabledReasongetDisabledReason(intindex)

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

publicabstractintgetDisabledReasonCount()

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

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

publicabstractintgetDisabledReasonValue(intindex)

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

publicabstractList<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()

publicabstractStringgetDisplayName()

Display name for an instance.

string display_name = 18;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

publicabstractByteStringgetDisplayNameBytes()

Display name for an instance.

string display_name = 18;

Returns
Type Description
ByteString

The bytes for displayName.

getEnableRbac()

publicabstractbooleangetEnableRbac()

Option to enable granular role-based access control.

bool enable_rbac = 26;

Returns
Type Description
boolean

The enableRbac.

getEnableStackdriverLogging()

publicabstractbooleangetEnableStackdriverLogging()

Option to enable Stackdriver Logging.

bool enable_stackdriver_logging = 4;

Returns
Type Description
boolean

The enableStackdriverLogging.

getEnableStackdriverMonitoring()

publicabstractbooleangetEnableStackdriverMonitoring()

Option to enable Stackdriver Monitoring.

bool enable_stackdriver_monitoring = 5;

Returns
Type Description
boolean

The enableStackdriverMonitoring.

getGcsBucket()

publicabstractStringgetGcsBucket()

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

publicabstractByteStringgetGcsBucketBytes()

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

publicabstractMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description

getLabelsCount()

publicabstractintgetLabelsCount()

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

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

getLabelsOrDefault(String key, String defaultValue)

publicabstractStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

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

getLabelsOrThrow(String key)

publicabstractStringgetLabelsOrThrow(Stringkey)

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

getName()

publicabstractStringgetName()

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

publicabstractByteStringgetNameBytes()

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

publicabstractNetworkConfiggetNetworkConfig()

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

publicabstractNetworkConfigOrBuildergetNetworkConfigOrBuilder()

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

getOptions()

publicabstractMap<String,String>getOptions()

Use #getOptionsMap() instead.

Returns
Type Description

getOptionsCount()

publicabstractintgetOptionsCount()

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

map<string, string> options = 9;

Returns
Type Description
int

getOptionsMap()

publicabstractMap<String,String>getOptionsMap()

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

map<string, string> options = 9;

Returns
Type Description

getOptionsOrDefault(String key, String defaultValue)

publicabstractStringgetOptionsOrDefault(Stringkey,StringdefaultValue)

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

getOptionsOrThrow(String key)

publicabstractStringgetOptionsOrThrow(Stringkey)

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

getP4ServiceAccount()

publicabstractStringgetP4ServiceAccount()

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

publicabstractByteStringgetP4ServiceAccountBytes()

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

publicabstractbooleangetPrivateInstance()

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)

publicabstractStringgetServiceAccount()

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)

publicabstractByteStringgetServiceAccountBytes()

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

publicabstractStringgetServiceEndpoint()

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

publicabstractByteStringgetServiceEndpointBytes()

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

publicabstractInstance.StategetState()

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

publicabstractStringgetStateMessage()

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

publicabstractByteStringgetStateMessageBytes()

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

publicabstractintgetStateValue()

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

publicabstractStringgetTenantProjectId()

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

publicabstractByteStringgetTenantProjectIdBytes()

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

publicabstractInstance.TypegetType()

Required. Instance type.

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

Returns
Type Description
Instance.Type

The type.

getTypeValue()

publicabstractintgetTypeValue()

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

publicabstractTimestampgetUpdateTime()

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

publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()

Output only. The time the instance was last updated.

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

Returns
Type Description

getVersion()

publicabstractStringgetVersion()

Current version of Data Fusion.

string version = 16;

Returns
Type Description
String

The version.

getVersionBytes()

publicabstractByteStringgetVersionBytes()

Current version of Data Fusion.

string version = 16;

Returns
Type Description
ByteString

The bytes for version.

getZone()

publicabstractStringgetZone()

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

publicabstractByteStringgetZoneBytes()

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

publicabstractbooleanhasCreateTime()

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

publicabstractbooleanhasCryptoKeyConfig()

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

publicabstractbooleanhasNetworkConfig()

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

publicabstractbooleanhasUpdateTime()

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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.