Class Instance (1.34.0)

public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder

Represents a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.Instance

Implements

InstanceOrBuilder

Static Fields

ACCELERATORS_FIELD_NUMBER

public static final int ACCELERATORS_FIELD_NUMBER
Field Value
TypeDescription
int

API_ENDPOINT_FIELD_NUMBER

public static final int API_ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

AVAILABLE_VERSION_FIELD_NUMBER

public static final int AVAILABLE_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CRYPTO_KEY_CONFIG_FIELD_NUMBER

public static final int CRYPTO_KEY_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

DATAPROC_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int DATAPROC_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLED_REASON_FIELD_NUMBER

public static final int DISABLED_REASON_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_RBAC_FIELD_NUMBER

public static final int ENABLE_RBAC_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_STACKDRIVER_LOGGING_FIELD_NUMBER

public static final int ENABLE_STACKDRIVER_LOGGING_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_STACKDRIVER_MONITORING_FIELD_NUMBER

public static final int ENABLE_STACKDRIVER_MONITORING_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_BUCKET_FIELD_NUMBER

public static final int GCS_BUCKET_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_CONFIG_FIELD_NUMBER

public static final int NETWORK_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

P4_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int P4_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PRIVATE_INSTANCE_FIELD_NUMBER

public static final int PRIVATE_INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ENDPOINT_FIELD_NUMBER

public static final int SERVICE_ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

TENANT_PROJECT_ID_FIELD_NUMBER

public static final int TENANT_PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()
Returns
TypeDescription
Instance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Instance.Builder newBuilder()
Returns
TypeDescription
Instance.Builder

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)
Parameter
NameDescription
prototypeInstance
Returns
TypeDescription
Instance.Builder

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Instance> parser()
Returns
TypeDescription
Parser<Instance>

Methods

containsLabels(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
boolean

containsOptions(String key)

public boolean containsOptions(String key)

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

map<string, string> options = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAccelerators(int index)

public Accelerator getAccelerators(int index)

List of accelerators enabled for this CDF instance.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Accelerator

getAcceleratorsCount()

public int getAcceleratorsCount()

List of accelerators enabled for this CDF instance.

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

Returns
TypeDescription
int

getAcceleratorsList()

public List<Accelerator> getAcceleratorsList()

List of accelerators enabled for this CDF instance.

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

Returns
TypeDescription
List<Accelerator>

getAcceleratorsOrBuilder(int index)

public AcceleratorOrBuilder getAcceleratorsOrBuilder(int index)

List of accelerators enabled for this CDF instance.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AcceleratorOrBuilder

getAcceleratorsOrBuilderList()

public List<? extends AcceleratorOrBuilder> getAcceleratorsOrBuilderList()

List of accelerators enabled for this CDF instance.

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

Returns
TypeDescription
List<? extends com.google.cloud.datafusion.v1.AcceleratorOrBuilder>

getApiEndpoint()

public String getApiEndpoint()

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

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

Returns
TypeDescription
String

The apiEndpoint.

getApiEndpointBytes()

public ByteString getApiEndpointBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for apiEndpoint.

getAvailableVersion(int index)

public Version getAvailableVersion(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Version

getAvailableVersionCount()

public int getAvailableVersionCount()

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

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

Returns
TypeDescription
int

getAvailableVersionList()

public List<Version> getAvailableVersionList()

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

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

Returns
TypeDescription
List<Version>

getAvailableVersionOrBuilder(int index)

public VersionOrBuilder getAvailableVersionOrBuilder(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
VersionOrBuilder

getAvailableVersionOrBuilderList()

public List<? extends VersionOrBuilder> getAvailableVersionOrBuilderList()

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

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

Returns
TypeDescription
List<? extends com.google.cloud.datafusion.v1.VersionOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the instance was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the instance was created.

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

Returns
TypeDescription
TimestampOrBuilder

getCryptoKeyConfig()

public CryptoKeyConfig getCryptoKeyConfig()

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

.google.cloud.datafusion.v1.CryptoKeyConfig crypto_key_config = 28;

Returns
TypeDescription
CryptoKeyConfig

The cryptoKeyConfig.

getCryptoKeyConfigOrBuilder()

public CryptoKeyConfigOrBuilder getCryptoKeyConfigOrBuilder()

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

.google.cloud.datafusion.v1.CryptoKeyConfig crypto_key_config = 28;

Returns
TypeDescription
CryptoKeyConfigOrBuilder

getDataprocServiceAccount()

public 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
TypeDescription
String

The dataprocServiceAccount.

getDataprocServiceAccountBytes()

public 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
TypeDescription
ByteString

The bytes for dataprocServiceAccount.

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
Instance

getDescription()

public String getDescription()

A description of this instance.

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A description of this instance.

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getDisabledReason(int index)

public Instance.DisabledReason getDisabledReason(int index)

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

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
Instance.DisabledReason

The disabledReason at the given index.

getDisabledReasonCount()

public int getDisabledReasonCount()

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

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

Returns
TypeDescription
int

The count of disabledReason.

getDisabledReasonList()

public List<Instance.DisabledReason> getDisabledReasonList()

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

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

Returns
TypeDescription
List<DisabledReason>

A list containing the disabledReason.

getDisabledReasonValue(int index)

public int getDisabledReasonValue(int index)

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

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
int

The enum numeric value on the wire of disabledReason at the given index.

getDisabledReasonValueList()

public List<Integer> getDisabledReasonValueList()

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

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

Returns
TypeDescription
List<Integer>

A list containing the enum numeric values on the wire for disabledReason.

getDisplayName()

public String getDisplayName()

Display name for an instance.

string display_name = 18;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name for an instance.

string display_name = 18;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEnableRbac()

public boolean getEnableRbac()

Option to enable granular role-based access control.

bool enable_rbac = 27;

Returns
TypeDescription