Class Entity (1.91.0) (original) (raw)

public final class Entity extends GeneratedMessage implements EntityOrBuilder

Represents tables and fileset metadata contained within a zone.

Protobuf type google.cloud.dataplex.v1.Entity

Inherited Members

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.makeMutableCopy(ListT,int)

com.google.protobuf.GeneratedMessage.emptyList(java.lang.Class)

com.google.protobuf.GeneratedMessage.serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

Static Fields

ACCESS_FIELD_NUMBER

public static final int ACCESS_FIELD_NUMBER

ASSET_FIELD_NUMBER

public static final int ASSET_FIELD_NUMBER

CATALOG_ENTRY_FIELD_NUMBER

public static final int CATALOG_ENTRY_FIELD_NUMBER

COMPATIBILITY_FIELD_NUMBER

public static final int COMPATIBILITY_FIELD_NUMBER

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

DATA_PATH_FIELD_NUMBER

public static final int DATA_PATH_FIELD_NUMBER

DATA_PATH_PATTERN_FIELD_NUMBER

public static final int DATA_PATH_PATTERN_FIELD_NUMBER

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER

SYSTEM_FIELD_NUMBER

public static final int SYSTEM_FIELD_NUMBER

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Static Methods

getDefaultInstance()

public static Entity getDefaultInstance()

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

newBuilder()

public static Entity.Builder newBuilder()

newBuilder(Entity prototype)

public static Entity.Builder newBuilder(Entity prototype)

parseDelimitedFrom(InputStream input)

public static Entity parseDelimitedFrom(InputStream input)

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(byte[] data)

public static Entity parseFrom(byte[] data)

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteString data)

public static Entity parseFrom(ByteString data)

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom(CodedInputStream input)

public static Entity parseFrom(CodedInputStream input)

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(InputStream input)

public static Entity parseFrom(InputStream input)

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteBuffer data)

public static Entity parseFrom(ByteBuffer data)

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parser()

public static Parser<Entity> parser()

Methods

equals(Object obj)

public boolean equals(Object obj)

Overrides

getAccess()

public StorageAccess getAccess()

Output only. Identifies the access mechanism to the entity. Not user settable.

.google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

getAccessOrBuilder()

public StorageAccessOrBuilder getAccessOrBuilder()

Output only. Identifies the access mechanism to the entity. Not user settable.

.google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

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];

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];

getCatalogEntry()

public String getCatalogEntry()

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

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

getCatalogEntryBytes()

public ByteString getCatalogEntryBytes()

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

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

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];

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];

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];

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];

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 asprojects/project_id/datasets/dataset_id/tables/table_id.

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

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 asprojects/project_id/datasets/dataset_id/tables/table_id.

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

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];

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];

getDefaultInstanceForType()

public Entity getDefaultInstanceForType()

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];

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];

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];

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];

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];

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];

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];

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];

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, and consist of 256 or fewer characters.

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

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, and consist of 256 or fewer characters.

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

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) = { ... }

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) = { ... }

getParserForType()

public Parser<Entity> getParserForType()

Overrides

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 inSCHEMA and FULL entity views of a GetEntity response.

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

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 inSCHEMA and FULL entity views of a GetEntity response.

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

getSerializedSize()

public int getSerializedSize()

Overrides

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];

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];

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];

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];

getUid()

Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.

string uid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

getUidBytes()

public ByteString getUidBytes()

Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.

string uid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

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];

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];

hasAccess()

public boolean hasAccess()

Output only. Identifies the access mechanism to the entity. Not user settable.

.google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

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];

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];

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];

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 inSCHEMA and FULL entity views of a GetEntity response.

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

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];

hashCode()

Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Overrides

isInitialized()

public final boolean isInitialized()

Overrides

newBuilderForType()

public Entity.Builder newBuilderForType()

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Entity.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Overrides

toBuilder()

public Entity.Builder toBuilder()

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Overrides