public final class Entry extends GeneratedMessageV3 implements EntryOrBuilder
Entry Metadata.
A Data Catalog Entry resource represents another resource in Google
Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or
outside of Google Cloud Platform. Clients can use the `linked_resource` field
in the Entry resource to refer to the original resource ID of the source
system.
An Entry resource contains resource details, such as its schema. An Entry can
also be used to attach flexible metadata, such as a
[Tag][google.cloud.datacatalog.v1beta1.Tag].
Protobuf type google.cloud.datacatalog.v1beta1.Entry
Fields
BIGQUERY_DATE_SHARDED_SPEC_FIELD_NUMBER
public static final int BIGQUERY_DATE_SHARDED_SPEC_FIELD_NUMBER
Field Value
BIGQUERY_TABLE_SPEC_FIELD_NUMBER
public static final int BIGQUERY_TABLE_SPEC_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
GCS_FILESET_SPEC_FIELD_NUMBER
public static final int GCS_FILESET_SPEC_FIELD_NUMBER
Field Value
INTEGRATED_SYSTEM_FIELD_NUMBER
public static final int INTEGRATED_SYSTEM_FIELD_NUMBER
Field Value
LINKED_RESOURCE_FIELD_NUMBER
public static final int LINKED_RESOURCE_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
SOURCE_SYSTEM_TIMESTAMPS_FIELD_NUMBER
public static final int SOURCE_SYSTEM_TIMESTAMPS_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
USER_SPECIFIED_SYSTEM_FIELD_NUMBER
public static final int USER_SPECIFIED_SYSTEM_FIELD_NUMBER
Field Value
USER_SPECIFIED_TYPE_FIELD_NUMBER
public static final int USER_SPECIFIED_TYPE_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBigqueryDateShardedSpec()
public BigQueryDateShardedSpec getBigqueryDateShardedSpec()
Specification for a group of BigQuery tables with name pattern
`[prefix]YYYYMMDD`. Context:
https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
getBigqueryDateShardedSpecOrBuilder()
public BigQueryDateShardedSpecOrBuilder getBigqueryDateShardedSpecOrBuilder()
Specification for a group of BigQuery tables with name pattern
`[prefix]YYYYMMDD`. Context:
https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
getBigqueryTableSpec()
public BigQueryTableSpec getBigqueryTableSpec()
Specification that applies to a BigQuery table. This is only valid on
entries of type `TABLE`.
.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;
getBigqueryTableSpecOrBuilder()
public BigQueryTableSpecOrBuilder getBigqueryTableSpecOrBuilder()
Specification that applies to a BigQuery table. This is only valid on
entries of type `TABLE`.
.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;
getDefaultInstance()
public static Entry getDefaultInstance()
Returns
getDefaultInstanceForType()
public Entry getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Entry description, which can consist of several sentences or paragraphs
that describe entry contents. Default value is an empty string.
string description = 4;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Entry description, which can consist of several sentences or paragraphs
that describe entry contents. Default value is an empty string.
string description = 4;
| Type | Description |
| ByteString | The bytes for description.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDisplayName()
public String getDisplayName()
Display information such as title and description. A short name to identify
the entry, for example, "Analytics Data - Jan 2011". Default value is an
empty string.
string display_name = 3;
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Display information such as title and description. A short name to identify
the entry, for example, "Analytics Data - Jan 2011". Default value is an
empty string.
string display_name = 3;
| Type | Description |
| ByteString | The bytes for displayName.
|
getEntryTypeCase()
public Entry.EntryTypeCase getEntryTypeCase()
Returns
getGcsFilesetSpec()
public GcsFilesetSpec getGcsFilesetSpec()
Specification that applies to a Cloud Storage fileset. This is only valid
on entries of type FILESET.
.google.cloud.datacatalog.v1beta1.GcsFilesetSpec gcs_fileset_spec = 6;
getGcsFilesetSpecOrBuilder()
public GcsFilesetSpecOrBuilder getGcsFilesetSpecOrBuilder()
Specification that applies to a Cloud Storage fileset. This is only valid
on entries of type FILESET.
.google.cloud.datacatalog.v1beta1.GcsFilesetSpec gcs_fileset_spec = 6;
getIntegratedSystem()
public IntegratedSystem getIntegratedSystem()
Output only. This field indicates the entry's source system that Data Catalog
integrates with, such as BigQuery or Pub/Sub.
.google.cloud.datacatalog.v1beta1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
getIntegratedSystemValue()
public int getIntegratedSystemValue()
Output only. This field indicates the entry's source system that Data Catalog
integrates with, such as BigQuery or Pub/Sub.
.google.cloud.datacatalog.v1beta1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for integratedSystem.
|
getLinkedResource()
public String getLinkedResource()
The resource this metadata entry refers to.
For Google Cloud Platform resources, `linked_resource` is the [full name of
the
resource](https://cloud.google.com/apis/design/resource_names#full_resource_name).
For example, the `linked_resource` for a table resource from BigQuery is:
* //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
Output only when Entry is of type in the EntryType enum. For entries with
user_specified_type, this field is optional and defaults to an empty
string.
string linked_resource = 9;
| Type | Description |
| String | The linkedResource.
|
getLinkedResourceBytes()
public ByteString getLinkedResourceBytes()
The resource this metadata entry refers to.
For Google Cloud Platform resources, `linked_resource` is the [full name of
the
resource](https://cloud.google.com/apis/design/resource_names#full_resource_name).
For example, the `linked_resource` for a table resource from BigQuery is:
* //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
Output only when Entry is of type in the EntryType enum. For entries with
user_specified_type, this field is optional and defaults to an empty
string.
string linked_resource = 9;
| Type | Description |
| ByteString | The bytes for linkedResource.
|
getName()
The Data Catalog resource name of the entry in URL format. Example:
* projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Note that this Entry and its child resources may not actually be stored in
the location in this name.
string name = 1 [(.google.api.resource_reference) = { ... }
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The Data Catalog resource name of the entry in URL format. Example:
* projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Note that this Entry and its child resources may not actually be stored in
the location in this name.
string name = 1 [(.google.api.resource_reference) = { ... }
getParserForType()
public Parser<Entry> getParserForType()
Returns
Overrides
getSchema()
public Schema getSchema()
Schema of the entry. An entry might not have any schema attached to it.
.google.cloud.datacatalog.v1beta1.Schema schema = 5;
| Type | Description |
| Schema | The schema.
|
getSchemaOrBuilder()
public SchemaOrBuilder getSchemaOrBuilder()
Schema of the entry. An entry might not have any schema attached to it.
.google.cloud.datacatalog.v1beta1.Schema schema = 5;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceSystemTimestamps()
public SystemTimestamps getSourceSystemTimestamps()
Output only. Timestamps about the underlying resource, not about this Data Catalog
entry. Output only when Entry is of type in the EntryType enum. For entries
with user_specified_type, this field is optional and defaults to an empty
timestamp.
.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSourceSystemTimestampsOrBuilder()
public SystemTimestampsOrBuilder getSourceSystemTimestampsOrBuilder()
Output only. Timestamps about the underlying resource, not about this Data Catalog
entry. Output only when Entry is of type in the EntryType enum. For entries
with user_specified_type, this field is optional and defaults to an empty
timestamp.
.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSystemCase()
public Entry.SystemCase getSystemCase()
Returns
getType()
public EntryType getType()
The type of the entry.
Only used for Entries with types in the EntryType enum.
.google.cloud.datacatalog.v1beta1.EntryType type = 2;
getTypeSpecCase()
public Entry.TypeSpecCase getTypeSpecCase()
Returns
getTypeValue()
public int getTypeValue()
The type of the entry.
Only used for Entries with types in the EntryType enum.
.google.cloud.datacatalog.v1beta1.EntryType type = 2;
| Type | Description |
| int | The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUserSpecifiedSystem()
public String getUserSpecifiedSystem()
This field indicates the entry's source system that Data Catalog does not
integrate with. `user_specified_system` strings must begin with a letter
or underscore and can only contain letters, numbers, and underscores; are
case insensitive; must be at least 1 character and at most 64 characters
long.
string user_specified_system = 18;
| Type | Description |
| String | The userSpecifiedSystem.
|
getUserSpecifiedSystemBytes()
public ByteString getUserSpecifiedSystemBytes()
This field indicates the entry's source system that Data Catalog does not
integrate with. `user_specified_system` strings must begin with a letter
or underscore and can only contain letters, numbers, and underscores; are
case insensitive; must be at least 1 character and at most 64 characters
long.
string user_specified_system = 18;
| Type | Description |
| ByteString | The bytes for userSpecifiedSystem.
|
getUserSpecifiedType()
public String getUserSpecifiedType()
Entry type if it does not fit any of the input-allowed values listed in
`EntryType` enum above. When creating an entry, users should check the
enum values first, if nothing matches the entry to be created, then
provide a custom value, for example "my_special_type".
`user_specified_type` strings must begin with a letter or underscore and
can only contain letters, numbers, and underscores; are case insensitive;
must be at least 1 character and at most 64 characters long.
Currently, only FILESET enum value is allowed. All other entries created
through Data Catalog must use `user_specified_type`.
string user_specified_type = 16;
| Type | Description |
| String | The userSpecifiedType.
|
getUserSpecifiedTypeBytes()
public ByteString getUserSpecifiedTypeBytes()
Entry type if it does not fit any of the input-allowed values listed in
`EntryType` enum above. When creating an entry, users should check the
enum values first, if nothing matches the entry to be created, then
provide a custom value, for example "my_special_type".
`user_specified_type` strings must begin with a letter or underscore and
can only contain letters, numbers, and underscores; are case insensitive;
must be at least 1 character and at most 64 characters long.
Currently, only FILESET enum value is allowed. All other entries created
through Data Catalog must use `user_specified_type`.
string user_specified_type = 16;
| Type | Description |
| ByteString | The bytes for userSpecifiedType.
|
hasBigqueryDateShardedSpec()
public boolean hasBigqueryDateShardedSpec()
Specification for a group of BigQuery tables with name pattern
`[prefix]YYYYMMDD`. Context:
https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
| Type | Description |
| boolean | Whether the bigqueryDateShardedSpec field is set.
|
hasBigqueryTableSpec()
public boolean hasBigqueryTableSpec()
Specification that applies to a BigQuery table. This is only valid on
entries of type `TABLE`.
.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;
| Type | Description |
| boolean | Whether the bigqueryTableSpec field is set.
|
hasGcsFilesetSpec()
public boolean hasGcsFilesetSpec()
Specification that applies to a Cloud Storage fileset. This is only valid
on entries of type FILESET.
.google.cloud.datacatalog.v1beta1.GcsFilesetSpec gcs_fileset_spec = 6;
| Type | Description |
| boolean | Whether the gcsFilesetSpec field is set.
|
hasIntegratedSystem()
public boolean hasIntegratedSystem()
Output only. This field indicates the entry's source system that Data Catalog
integrates with, such as BigQuery or Pub/Sub.
.google.cloud.datacatalog.v1beta1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the integratedSystem field is set.
|
hasSchema()
public boolean hasSchema()
Schema of the entry. An entry might not have any schema attached to it.
.google.cloud.datacatalog.v1beta1.Schema schema = 5;
| Type | Description |
| boolean | Whether the schema field is set.
|
hasSourceSystemTimestamps()
public boolean hasSourceSystemTimestamps()
Output only. Timestamps about the underlying resource, not about this Data Catalog
entry. Output only when Entry is of type in the EntryType enum. For entries
with user_specified_type, this field is optional and defaults to an empty
timestamp.
.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the sourceSystemTimestamps field is set.
|
hasType()
The type of the entry.
Only used for Entries with types in the EntryType enum.
.google.cloud.datacatalog.v1beta1.EntryType type = 2;
| Type | Description |
| boolean | Whether the type field is set.
|
hasUserSpecifiedSystem()
public boolean hasUserSpecifiedSystem()
This field indicates the entry's source system that Data Catalog does not
integrate with. `user_specified_system` strings must begin with a letter
or underscore and can only contain letters, numbers, and underscores; are
case insensitive; must be at least 1 character and at most 64 characters
long.
string user_specified_system = 18;
| Type | Description |
| boolean | Whether the userSpecifiedSystem field is set.
|
hasUserSpecifiedType()
public boolean hasUserSpecifiedType()
Entry type if it does not fit any of the input-allowed values listed in
`EntryType` enum above. When creating an entry, users should check the
enum values first, if nothing matches the entry to be created, then
provide a custom value, for example "my_special_type".
`user_specified_type` strings must begin with a letter or underscore and
can only contain letters, numbers, and underscores; are case insensitive;
must be at least 1 character and at most 64 characters long.
Currently, only FILESET enum value is allowed. All other entries created
through Data Catalog must use `user_specified_type`.
string user_specified_type = 16;
| Type | Description |
| boolean | Whether the userSpecifiedType field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Entry.Builder newBuilder()
Returns
newBuilder(Entry prototype)
public static Entry.Builder newBuilder(Entry prototype)
Parameter
| Name | Description |
| prototype | Entry
|
Returns
newBuilderForType()
public Entry.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Entry.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
parseDelimitedFrom(InputStream input)
public static Entry parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Entry parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Entry parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Entry parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Entry parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Entry parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static Entry parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Entry parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static Entry parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Entry parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Entry parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Entry parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Entry> parser()
Returns
toBuilder()
public Entry.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
