public final class Entity extends GeneratedMessageV3 implements EntityOrBuilder
Represents tables and fileset metadata contained within a zone.
Protobuf type google.cloud.dataplex.v1.Entity
Static Fields
ASSET_FIELD_NUMBER
public static final int ASSET_FIELD_NUMBER
Field Value
CATALOG_ENTRY_FIELD_NUMBER
public static final int CATALOG_ENTRY_FIELD_NUMBER
Field Value
COMPATIBILITY_FIELD_NUMBER
public static final int COMPATIBILITY_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DATA_PATH_FIELD_NUMBER
public static final int DATA_PATH_FIELD_NUMBER
Field Value
DATA_PATH_PATTERN_FIELD_NUMBER
public static final int DATA_PATH_PATTERN_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
public static final int FORMAT_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SCHEMA_FIELD_NUMBER
public static final int SCHEMA_FIELD_NUMBER
Field Value
SYSTEM_FIELD_NUMBER
public static final int SYSTEM_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Entity getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Entity.Builder newBuilder()
Returns
newBuilder(Entity prototype)
public static Entity.Builder newBuilder(Entity prototype)
Parameter
| Name | Description |
| prototype | Entity
|
Returns
public static Entity parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Entity parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Entity parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entity parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entity parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Entity parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Entity> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
| 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];
getCatalogEntry()
public String getCatalogEntry()
Output only. The name of the associated Data Catalog entry.
string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
| 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];
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 as
projects/project_id/datasets/dataset_id/tables/table_id.
string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| 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];
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];
| 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];
| Type | Description |
| ByteString | The bytes for dataPathPattern.
|
getDefaultInstanceForType()
public Entity getDefaultInstanceForType()
Returns
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];
| 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];
| Type | Description |
| ByteString | The bytes for description.
|
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];
| 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];
| Type | Description |
| ByteString | The bytes for displayName.
|
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];
| 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];
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];
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. Must begin with a letter 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. Must begin with a letter 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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<Entity> getParserForType()
Returns
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 in
SCHEMA and FULL entity views of a GetEntity response.
.google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| Schema | The schema.
|
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];
getSerializedSize()
public int getSerializedSize()
Returns
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];
| 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];
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];
| Type | Description |
| int | The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
| 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];
| Type | Description |
| boolean | Whether the createTime field is set.
|
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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Entity.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Entity.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
