Class Entity.Builder (1.2.0)

Version 1.2.0

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.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.38.0
• 1.37.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.26.0
• 1.25.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.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

public static final class Entity.Builder extends GeneratedMessageV3.Builder<Entity.Builder> implements EntityOrBuilder

Represents tables and fileset metadata contained within a zone.

Protobuf type google.cloud.dataplex.v1.Entity

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Entity.Builder

Implements

EntityOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Entity build()

Returns

Type	Description
Entity

buildPartial()

public Entity buildPartial()

Returns

Type	Description
Entity

clear()

public Entity.Builder clear()

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAsset()

public Entity.Builder clearAsset()

Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearCatalogEntry()

public Entity.Builder clearCatalogEntry()

Output only. The name of the associated Data Catalog entry.

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

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearCompatibility()

public Entity.Builder clearCompatibility()

Output only. Metadata stores that the entity is compatible with.

.google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Entity.Builder

clearCreateTime()

public Entity.Builder clearCreateTime()

Output only. The time when the entity was created.

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

Returns

Type	Description
Entity.Builder

clearDataPath()

public Entity.Builder clearDataPath()

Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearDataPathPattern()

public Entity.Builder clearDataPathPattern()

Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearDescription()

public Entity.Builder clearDescription()

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearDisplayName()

public Entity.Builder clearDisplayName()

Optional. Display name must be shorter than or equal to 256 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearEtag()

public Entity.Builder clearEtag()

Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Entity.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFormat()

public Entity.Builder clearFormat()

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

.google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Entity.Builder

clearId()

public Entity.Builder clearId()

Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores. Must begin with a letter and consist of 256 or fewer characters.

string id = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearName()

public Entity.Builder clearName()

Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.

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

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSchema()

public Entity.Builder clearSchema()

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Entity.Builder

clearSystem()

public Entity.Builder clearSystem()

Required. Immutable. Identifies the storage system of the entity data.

.google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearType()

public Entity.Builder clearType()

Required. Immutable. The type of entity.

.google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Entity.Builder	This builder for chaining.

clearUpdateTime()

public Entity.Builder clearUpdateTime()

Output only. The time when the entity was last updated.

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

Returns

Type	Description
Entity.Builder

clone()

public Entity.Builder clone()

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAsset()

public String getAsset()

Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
String	The asset.

getAssetBytes()

public ByteString getAssetBytes()

Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
ByteString	The bytes for asset.

getCatalogEntry()

public String getCatalogEntry()

Output only. The name of the associated Data Catalog entry.

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

Returns

Type	Description
String	The catalogEntry.

getCatalogEntryBytes()

public ByteString getCatalogEntryBytes()

Output only. The name of the associated Data Catalog entry.

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

Returns

Type	Description
ByteString	The bytes for catalogEntry.

getCompatibility()

public Entity.CompatibilityStatus getCompatibility()

Output only. Metadata stores that the entity is compatible with.

.google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Entity.CompatibilityStatus	The compatibility.

getCompatibilityBuilder()

public Entity.CompatibilityStatus.Builder getCompatibilityBuilder()

Output only. Metadata stores that the entity is compatible with.

.google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Entity.CompatibilityStatus.Builder

getCompatibilityOrBuilder()

public Entity.CompatibilityStatusOrBuilder getCompatibilityOrBuilder()

Output only. Metadata stores that the entity is compatible with.

.google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Entity.CompatibilityStatusOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the entity was created.

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

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the entity was created.

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

Returns

Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the entity was created.

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

Returns

Type	Description
TimestampOrBuilder

getDataPath()

public String getDataPath()

Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
String	The dataPath.

getDataPathBytes()

public ByteString getDataPathBytes()

Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
ByteString	The bytes for dataPath.

getDataPathPattern()

public String getDataPathPattern()

Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The dataPathPattern.

getDataPathPatternBytes()

public ByteString getDataPathPatternBytes()

Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for dataPathPattern.

getDefaultInstanceForType()

public Entity getDefaultInstanceForType()

Returns

Type	Description
Entity

getDescription()

public String getDescription()

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Optional. Display name must be shorter than or equal to 256 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name must be shorter than or equal to 256 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for displayName.

getEtag()

public String getEtag()

Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for etag.

getFormat()

public StorageFormat getFormat()

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

.google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
StorageFormat	The format.

getFormatBuilder()

public StorageFormat.Builder getFormatBuilder()

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

.google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
StorageFormat.Builder

getFormatOrBuilder()

public StorageFormatOrBuilder getFormatOrBuilder()

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

.google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
StorageFormatOrBuilder

getId()

public String getId()

Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores. Must begin with a letter and consist of 256 or fewer characters.

string id = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The id.

getIdBytes()

public ByteString getIdBytes()

Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores. Must begin with a letter and consist of 256 or fewer characters.

string id = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for id.

getName()

public String getName()

Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.

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

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.

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

Returns

Type	Description
ByteString	The bytes for name.

getSchema()

public Schema getSchema()

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Schema	The schema.

getSchemaBuilder()

public Schema.Builder getSchemaBuilder()

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Schema.Builder

getSchemaOrBuilder()

public SchemaOrBuilder getSchemaOrBuilder()

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
SchemaOrBuilder

getSystem()

public StorageSystem getSystem()

Required. Immutable. Identifies the storage system of the entity data.

.google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
StorageSystem	The system.

getSystemValue()

public int getSystemValue()

Required. Immutable. Identifies the storage system of the entity data.

.google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

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

getType()

public Entity.Type getType()

Required. Immutable. The type of entity.

.google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Entity.Type	The type.

getTypeValue()

public int getTypeValue()

Required. Immutable. The type of entity.

.google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

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

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the entity was last updated.

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

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time when the entity was last updated.

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

Returns

Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the entity was last updated.

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

Returns

Type	Description
TimestampOrBuilder

hasCompatibility()

public boolean hasCompatibility()

Output only. Metadata stores that the entity is compatible with.

.google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the compatibility field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the entity was created.

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

Returns

Type	Description
boolean	Whether the createTime field is set.

hasFormat()

public boolean hasFormat()

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

.google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the format field is set.

hasSchema()

public boolean hasSchema()

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the schema field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the entity was last updated.

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

Returns

Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCompatibility(Entity.CompatibilityStatus value)

public Entity.Builder mergeCompatibility(Entity.CompatibilityStatus value)

Output only. Metadata stores that the entity is compatible with.

.google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Entity.CompatibilityStatus

Returns

Type	Description
Entity.Builder

mergeCreateTime(Timestamp value)

public Entity.Builder mergeCreateTime(Timestamp value)

Output only. The time when the entity was created.

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

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
Entity.Builder

mergeFormat(StorageFormat value)

public Entity.Builder mergeFormat(StorageFormat value)

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

.google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	StorageFormat

Returns

Type	Description
Entity.Builder

mergeFrom(Entity other)

public Entity.Builder mergeFrom(Entity other)

Parameter

Name	Description
other	Entity

Returns

Type	Description
Entity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Entity.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Entity.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
Entity.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSchema(Schema value)

public Entity.Builder mergeSchema(Schema value)

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	Schema

Returns

Type	Description
Entity.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Entity.Builder mergeUpdateTime(Timestamp value)

Output only. The time when the entity was last updated.

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

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
Entity.Builder

setAsset(String value)

public Entity.Builder setAsset(String value)

Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	String The asset to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setAssetBytes(ByteString value)

public Entity.Builder setAssetBytes(ByteString value)

Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	ByteString The bytes for asset to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setCatalogEntry(String value)

public Entity.Builder setCatalogEntry(String value)

Output only. The name of the associated Data Catalog entry.

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

Parameter

Name	Description
value	String The catalogEntry to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setCatalogEntryBytes(ByteString value)

public Entity.Builder setCatalogEntryBytes(ByteString value)

Output only. The name of the associated Data Catalog entry.

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

Parameter

Name	Description
value	ByteString The bytes for catalogEntry to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setCompatibility(Entity.CompatibilityStatus value)

public Entity.Builder setCompatibility(Entity.CompatibilityStatus value)

Output only. Metadata stores that the entity is compatible with.

.google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Entity.CompatibilityStatus

Returns

Type	Description
Entity.Builder

setCompatibility(Entity.CompatibilityStatus.Builder builderForValue)

public Entity.Builder setCompatibility(Entity.CompatibilityStatus.Builder builderForValue)

Output only. Metadata stores that the entity is compatible with.

.google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	Entity.CompatibilityStatus.Builder

Returns

Type	Description
Entity.Builder

setCreateTime(Timestamp value)

public Entity.Builder setCreateTime(Timestamp value)

Output only. The time when the entity was created.

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

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
Entity.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Entity.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the entity was created.

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

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
Entity.Builder

setDataPath(String value)

public Entity.Builder setDataPath(String value)

Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	String The dataPath to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setDataPathBytes(ByteString value)

public Entity.Builder setDataPathBytes(ByteString value)

Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	ByteString The bytes for dataPath to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setDataPathPattern(String value)

public Entity.Builder setDataPathPattern(String value)

Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	String The dataPathPattern to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setDataPathPatternBytes(ByteString value)

public Entity.Builder setDataPathPatternBytes(ByteString value)

Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for dataPathPattern to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setDescription(String value)

public Entity.Builder setDescription(String value)

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	String The description to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Entity.Builder setDescriptionBytes(ByteString value)

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for description to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setDisplayName(String value)

public Entity.Builder setDisplayName(String value)

Optional. Display name must be shorter than or equal to 256 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	String The displayName to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Entity.Builder setDisplayNameBytes(ByteString value)

Optional. Display name must be shorter than or equal to 256 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for displayName to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setEtag(String value)

public Entity.Builder setEtag(String value)

Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	String The etag to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setEtagBytes(ByteString value)

public Entity.Builder setEtagBytes(ByteString value)

Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for etag to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Entity.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFormat(StorageFormat value)

public Entity.Builder setFormat(StorageFormat value)

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

.google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	StorageFormat

Returns

Type	Description
Entity.Builder

setFormat(StorageFormat.Builder builderForValue)

public Entity.Builder setFormat(StorageFormat.Builder builderForValue)

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

.google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	StorageFormat.Builder

Returns

Type	Description
Entity.Builder

setId(String value)

public Entity.Builder setId(String value)

Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores. Must begin with a letter and consist of 256 or fewer characters.

string id = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	String The id to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setIdBytes(ByteString value)

public Entity.Builder setIdBytes(ByteString value)

Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores. Must begin with a letter and consist of 256 or fewer characters.

string id = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	ByteString The bytes for id to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setName(String value)

public Entity.Builder setName(String value)

Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.

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

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Entity.Builder setNameBytes(ByteString value)

Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.

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

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Entity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSchema(Schema value)

public Entity.Builder setSchema(Schema value)

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	Schema

Returns

Type	Description
Entity.Builder

setSchema(Schema.Builder builderForValue)

public Entity.Builder setSchema(Schema.Builder builderForValue)

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	Schema.Builder

Returns

Type	Description
Entity.Builder

setSystem(StorageSystem value)

public Entity.Builder setSystem(StorageSystem value)

Required. Immutable. Identifies the storage system of the entity data.

.google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	StorageSystem The system to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setSystemValue(int value)

public Entity.Builder setSystemValue(int value)

Required. Immutable. Identifies the storage system of the entity data.

.google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	int The enum numeric value on the wire for system to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setType(Entity.Type value)

public Entity.Builder setType(Entity.Type value)

Required. Immutable. The type of entity.

.google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	Entity.Type The type to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setTypeValue(int value)

public Entity.Builder setTypeValue(int value)

Required. Immutable. The type of entity.

.google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	int The enum numeric value on the wire for type to set.

Returns

Type	Description
Entity.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Entity.Builder setUpdateTime(Timestamp value)

Output only. The time when the entity was last updated.

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

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
Entity.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Entity.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time when the entity was last updated.

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

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
Entity.Builder