Class Entry (1.61.0) 

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.

Protobuf type google.cloud.datacatalog.v1beta1.Entry

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Entry

Implements

EntryOrBuilder

Static Fields

BIGQUERY_DATE_SHARDED_SPEC_FIELD_NUMBER

public static final int BIGQUERY_DATE_SHARDED_SPEC_FIELD_NUMBER
Field Value
Type Description
int

BIGQUERY_TABLE_SPEC_FIELD_NUMBER

public static final int BIGQUERY_TABLE_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

GCS_FILESET_SPEC_FIELD_NUMBER

public static final int GCS_FILESET_SPEC_FIELD_NUMBER
Field Value
Type Description
int

INTEGRATED_SYSTEM_FIELD_NUMBER

public static final int INTEGRATED_SYSTEM_FIELD_NUMBER
Field Value
Type Description
int

LINKED_RESOURCE_FIELD_NUMBER

public static final int LINKED_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_SYSTEM_TIMESTAMPS_FIELD_NUMBER

public static final int SOURCE_SYSTEM_TIMESTAMPS_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

USAGE_SIGNAL_FIELD_NUMBER

public static final int USAGE_SIGNAL_FIELD_NUMBER
Field Value
Type Description
int

USER_SPECIFIED_SYSTEM_FIELD_NUMBER

public static final int USER_SPECIFIED_SYSTEM_FIELD_NUMBER
Field Value
Type Description
int

USER_SPECIFIED_TYPE_FIELD_NUMBER

public static final int USER_SPECIFIED_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Entry getDefaultInstance()
Returns
Type Description
Entry

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Entry.Builder newBuilder()
Returns
Type Description
Entry.Builder

newBuilder(Entry prototype)

public static Entry.Builder newBuilder(Entry prototype)
Parameter
Name Description
prototype Entry
Returns
Type Description
Entry.Builder

parseDelimitedFrom(InputStream input)

public static Entry parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Entry
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entry parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entry
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Entry parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Entry
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Entry parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entry
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Entry parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Entry
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Entry parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entry
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Entry parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Entry
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Entry parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entry
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Entry parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Entry
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entry parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entry
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Entry parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Entry
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Entry parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entry
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Entry> parser()
Returns
Type Description
Parser<Entry>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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;

Returns
Type Description
BigQueryDateShardedSpec

The bigqueryDateShardedSpec.

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;

Returns
Type Description
BigQueryDateShardedSpecOrBuilder

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;

Returns
Type Description
BigQueryTableSpec

The bigqueryTableSpec.

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;

Returns
Type Description
BigQueryTableSpecOrBuilder

getDefaultInstanceForType()

public Entry getDefaultInstanceForType()
Returns
Type Description
Entry

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;

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

Returns
Type Description
ByteString

The bytes for description.

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;

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

Returns
Type Description
ByteString

The bytes for displayName.

getEntryTypeCase()

public Entry.EntryTypeCase getEntryTypeCase()
Returns
Type Description
Entry.EntryTypeCase

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;

Returns
Type Description
GcsFilesetSpec

The gcsFilesetSpec.

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;

Returns
Type Description
GcsFilesetSpecOrBuilder

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

Returns
Type Description
IntegratedSystem

The integratedSystem.

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

Returns
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. 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;

Returns
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. 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;

Returns
Type Description
ByteString

The bytes for linkedResource.

getName()

public String getName()

Output only. Identifier. 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.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. 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.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Entry> getParserForType()
Returns
Type Description
Parser<Entry>
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;

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

Returns
Type Description
SchemaOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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];

Returns
Type Description
SystemTimestamps

The sourceSystemTimestamps.

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

Returns
Type Description
SystemTimestampsOrBuilder

getSystemCase()

public Entry.SystemCase getSystemCase()
Returns
Type Description
Entry.SystemCase

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;

Returns
Type Description
EntryType

The type.

getTypeSpecCase()

public Entry.TypeSpecCase getTypeSpecCase()
Returns
Type Description
Entry.TypeSpecCase

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;

Returns
Type Description
int

The enum numeric value on the wire for type.

getUsageSignal()

public UsageSignal getUsageSignal()

Output only. Statistics on the usage level of the resource.

.google.cloud.datacatalog.v1beta1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UsageSignal

The usageSignal.

getUsageSignalOrBuilder()

public UsageSignalOrBuilder getUsageSignalOrBuilder()

Output only. Statistics on the usage level of the resource.

.google.cloud.datacatalog.v1beta1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UsageSignalOrBuilder

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;

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

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

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

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

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

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

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

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

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

Returns
Type Description
boolean

Whether the sourceSystemTimestamps field is set.

hasType()

public boolean hasType()

The type of the entry. Only used for Entries with types in the EntryType enum.

.google.cloud.datacatalog.v1beta1.EntryType type = 2;

Returns
Type Description
boolean

Whether the type field is set.

hasUsageSignal()

public boolean hasUsageSignal()

Output only. Statistics on the usage level of the resource.

.google.cloud.datacatalog.v1beta1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the usageSignal 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;

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

Returns
Type Description
boolean

Whether the userSpecifiedType field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Entry.Builder newBuilderForType()
Returns
Type Description
Entry.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Entry.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Entry.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Entry.Builder toBuilder()
Returns
Type Description
Entry.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException