Class Entry (1.43.0)

Version 1.43.0

• 1.59.0 (latest)
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public final class Entry extends GeneratedMessageV3 implements EntryOrBuilder

Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You 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, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag.

Protobuf type google.cloud.datacatalog.v1.Entry

Inheritance

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

Implements

EntryOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

BUSINESS_CONTEXT_FIELD_NUMBER

public static final int BUSINESS_CONTEXT_FIELD_NUMBER

Field Value
Type	Description
int

CLOUD_BIGTABLE_SYSTEM_SPEC_FIELD_NUMBER

public static final int CLOUD_BIGTABLE_SYSTEM_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

DATABASE_TABLE_SPEC_FIELD_NUMBER

public static final int DATABASE_TABLE_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

DATASET_SPEC_FIELD_NUMBER

public static final int DATASET_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

DATA_SOURCE_CONNECTION_SPEC_FIELD_NUMBER

public static final int DATA_SOURCE_CONNECTION_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

DATA_SOURCE_FIELD_NUMBER

public static final int DATA_SOURCE_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

FILESET_SPEC_FIELD_NUMBER

public static final int FILESET_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

FULLY_QUALIFIED_NAME_FIELD_NUMBER

public static final int FULLY_QUALIFIED_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

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value
Type	Description
int

LINKED_RESOURCE_FIELD_NUMBER

public static final int LINKED_RESOURCE_FIELD_NUMBER

Field Value
Type	Description
int

LOOKER_SYSTEM_SPEC_FIELD_NUMBER

public static final int LOOKER_SYSTEM_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_SPEC_FIELD_NUMBER

public static final int MODEL_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

PERSONAL_DETAILS_FIELD_NUMBER

public static final int PERSONAL_DETAILS_FIELD_NUMBER

Field Value
Type	Description
int

ROUTINE_SPEC_FIELD_NUMBER

public static final int ROUTINE_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER

Field Value
Type	Description
int

SERVICE_SPEC_FIELD_NUMBER

public static final int SERVICE_SPEC_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

SQL_DATABASE_SYSTEM_SPEC_FIELD_NUMBER

public static final int SQL_DATABASE_SYSTEM_SPEC_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

containsLabels(String key)

public boolean containsLabels(String key)

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBigqueryDateShardedSpec()

public BigQueryDateShardedSpec getBigqueryDateShardedSpec()

Output only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BigQueryDateShardedSpec	The bigqueryDateShardedSpec.

getBigqueryDateShardedSpecOrBuilder()

public BigQueryDateShardedSpecOrBuilder getBigqueryDateShardedSpecOrBuilder()

Output only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BigQueryDateShardedSpecOrBuilder

getBigqueryTableSpec()

public BigQueryTableSpec getBigqueryTableSpec()

Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BigQueryTableSpec	The bigqueryTableSpec.

getBigqueryTableSpecOrBuilder()

public BigQueryTableSpecOrBuilder getBigqueryTableSpecOrBuilder()

Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BigQueryTableSpecOrBuilder

getBusinessContext()

public BusinessContext getBusinessContext()

Business Context of the entry. Not supported for BigQuery datasets

.google.cloud.datacatalog.v1.BusinessContext business_context = 37;

Returns
Type	Description
BusinessContext	The businessContext.

getBusinessContextOrBuilder()

public BusinessContextOrBuilder getBusinessContextOrBuilder()

Business Context of the entry. Not supported for BigQuery datasets

.google.cloud.datacatalog.v1.BusinessContext business_context = 37;

Returns
Type	Description
BusinessContextOrBuilder

getCloudBigtableSystemSpec()

public CloudBigtableSystemSpec getCloudBigtableSystemSpec()

Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

.google.cloud.datacatalog.v1.CloudBigtableSystemSpec cloud_bigtable_system_spec = 41;

Returns
Type	Description
CloudBigtableSystemSpec	The cloudBigtableSystemSpec.

getCloudBigtableSystemSpecOrBuilder()

public CloudBigtableSystemSpecOrBuilder getCloudBigtableSystemSpecOrBuilder()

Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

.google.cloud.datacatalog.v1.CloudBigtableSystemSpec cloud_bigtable_system_spec = 41;

Returns
Type	Description
CloudBigtableSystemSpecOrBuilder

getDataSource()

public DataSource getDataSource()

Output only. Physical location of the entry.

.google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataSource	The dataSource.

getDataSourceConnectionSpec()

public DataSourceConnectionSpec getDataSourceConnectionSpec()

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27;

Returns
Type	Description
DataSourceConnectionSpec	The dataSourceConnectionSpec.

getDataSourceConnectionSpecOrBuilder()

public DataSourceConnectionSpecOrBuilder getDataSourceConnectionSpecOrBuilder()

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27;

Returns
Type	Description
DataSourceConnectionSpecOrBuilder

getDataSourceOrBuilder()

public DataSourceOrBuilder getDataSourceOrBuilder()

Output only. Physical location of the entry.

.google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataSourceOrBuilder

getDatabaseTableSpec()

public DatabaseTableSpec getDatabaseTableSpec()

Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;

Returns
Type	Description
DatabaseTableSpec	The databaseTableSpec.

getDatabaseTableSpecOrBuilder()

public DatabaseTableSpecOrBuilder getDatabaseTableSpecOrBuilder()

Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;

Returns
Type	Description
DatabaseTableSpecOrBuilder

getDatasetSpec()

public DatasetSpec getDatasetSpec()

Specification that applies to a dataset.

.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;

Returns
Type	Description
DatasetSpec	The datasetSpec.

getDatasetSpecOrBuilder()

public DatasetSpecOrBuilder getDatasetSpecOrBuilder()

Specification that applies to a dataset.

.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;

Returns
Type	Description
DatasetSpecOrBuilder

getDefaultInstanceForType()

public Entry getDefaultInstanceForType()

Returns
Type	Description
Entry

getDescription()

public String getDescription()

Entry description that can consist of several sentences or paragraphs that describe entry contents.

The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.

string description = 4;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Entry description that can consist of several sentences or paragraphs that describe entry contents.

The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.

string description = 4;

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public String getDisplayName()

Display name of an entry.

The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.

string display_name = 3;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name of an entry.

The maximum size is 500 bytes when encoded in UTF-8. 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

getFilesetSpec()

public FilesetSpec getFilesetSpec()

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;

Returns
Type	Description
FilesetSpec	The filesetSpec.

getFilesetSpecOrBuilder()

public FilesetSpecOrBuilder getFilesetSpecOrBuilder()

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;

Returns
Type	Description
FilesetSpecOrBuilder

getFullyQualifiedName()

public String getFullyQualifiedName()

Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.

string fully_qualified_name = 29;

Returns
Type	Description
String	The fullyQualifiedName.

getFullyQualifiedNameBytes()

public ByteString getFullyQualifiedNameBytes()

Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.

string fully_qualified_name = 29;

Returns
Type	Description
ByteString	The bytes for fullyQualifiedName.

getGcsFilesetSpec()

public GcsFilesetSpec getGcsFilesetSpec()

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;

Returns
Type	Description
GcsFilesetSpec	The gcsFilesetSpec.

getGcsFilesetSpecOrBuilder()

public GcsFilesetSpecOrBuilder getGcsFilesetSpecOrBuilder()

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;

Returns
Type	Description
GcsFilesetSpecOrBuilder

getIntegratedSystem()

public IntegratedSystem getIntegratedSystem()

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
IntegratedSystem	The integratedSystem.

getIntegratedSystemValue()

public int getIntegratedSystemValue()

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Returns
Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getLinkedResource()

public String getLinkedResource()

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the Full Resource Name. For example, the linked_resource for a table resource from BigQuery is:

//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Output only when the entry is one of the types in the EntryType enum.

For entries with a user_specified_type, this field is optional and defaults to an empty string.

The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.

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 Resource Name. For example, the linked_resource for a table resource from BigQuery is:

//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Output only when the entry is one of the types in the EntryType enum.

For entries with a user_specified_type, this field is optional and defaults to an empty string.

The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.

string linked_resource = 9;

Returns
Type	Description
ByteString	The bytes for linkedResource.

getLookerSystemSpec()

public LookerSystemSpec getLookerSystemSpec()

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;

Returns
Type	Description
LookerSystemSpec	The lookerSystemSpec.

getLookerSystemSpecOrBuilder()

public LookerSystemSpecOrBuilder getLookerSystemSpecOrBuilder()

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;

Returns
Type	Description
LookerSystemSpecOrBuilder

getModelSpec()

public ModelSpec getModelSpec()

Model specification.

.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;

Returns
Type	Description
ModelSpec	The modelSpec.

getModelSpecOrBuilder()

public ModelSpecOrBuilder getModelSpecOrBuilder()

Model specification.

.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;

Returns
Type	Description
ModelSpecOrBuilder

getName()

public String getName()

Output only. The resource name of an entry in URL format.

Note: The entry itself and its child resources might not be stored in the location specified in its name.

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 an entry in URL format.

Note: The entry itself and its child resources might not be stored in the location specified in its name.

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

Returns
Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Entry> getParserForType()

Returns
Type	Description
Parser<Entry>

Overrides

GeneratedMessageV3.getParserForType()

getPersonalDetails()

public PersonalDetails getPersonalDetails()

Output only. Additional information related to the entry. Private to the current user.

.google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PersonalDetails	The personalDetails.

getPersonalDetailsOrBuilder()

public PersonalDetailsOrBuilder getPersonalDetailsOrBuilder()

Output only. Additional information related to the entry. Private to the current user.

.google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PersonalDetailsOrBuilder

getRoutineSpec()

public RoutineSpec getRoutineSpec()

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;

Returns
Type	Description
RoutineSpec	The routineSpec.

getRoutineSpecOrBuilder()

public RoutineSpecOrBuilder getRoutineSpecOrBuilder()

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;

Returns
Type	Description
RoutineSpecOrBuilder

getSchema()

public Schema getSchema()

Schema of the entry. An entry might not have any schema attached to it.

.google.cloud.datacatalog.v1.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.v1.Schema schema = 5;

Returns
Type	Description
SchemaOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getServiceSpec()

public ServiceSpec getServiceSpec()

Specification that applies to a Service resource.

.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;

Returns
Type	Description
ServiceSpec	The serviceSpec.

getServiceSpecOrBuilder()

public ServiceSpecOrBuilder getServiceSpecOrBuilder()

Specification that applies to a Service resource.

.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;

Returns
Type	Description
ServiceSpecOrBuilder

getSourceSystemTimestamps()

public SystemTimestamps getSourceSystemTimestamps()

Timestamps from the underlying resource, not from the Data Catalog entry.

Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;

Returns
Type	Description
SystemTimestamps	The sourceSystemTimestamps.

getSourceSystemTimestampsOrBuilder()

public SystemTimestampsOrBuilder getSourceSystemTimestampsOrBuilder()

Timestamps from the underlying resource, not from the Data Catalog entry.

Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;

Returns
Type	Description
SystemTimestampsOrBuilder

getSpecCase()

public Entry.SpecCase getSpecCase()

Returns
Type	Description
Entry.SpecCase

getSqlDatabaseSystemSpec()

public SqlDatabaseSystemSpec getSqlDatabaseSystemSpec()

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;

Returns
Type	Description
SqlDatabaseSystemSpec	The sqlDatabaseSystemSpec.

getSqlDatabaseSystemSpecOrBuilder()

public SqlDatabaseSystemSpecOrBuilder getSqlDatabaseSystemSpecOrBuilder()

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;

Returns
Type	Description
SqlDatabaseSystemSpecOrBuilder

getSystemCase()

public Entry.SystemCase getSystemCase()

Returns
Type	Description
Entry.SystemCase

getSystemSpecCase()

public Entry.SystemSpecCase getSystemSpecCase()

Returns
Type	Description
Entry.SystemSpecCase

getType()

public EntryType getType()

The type of the entry.

For details, see EntryType.

.google.cloud.datacatalog.v1.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.

For details, see EntryType.

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

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

getUsageSignal()

public UsageSignal getUsageSignal()

Resource usage statistics.

.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;

Returns
Type	Description
UsageSignal	The usageSignal.

getUsageSignalOrBuilder()

public UsageSignalOrBuilder getUsageSignalOrBuilder()

Resource usage statistics.

.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;

Returns
Type	Description
UsageSignalOrBuilder

getUserSpecifiedSystem()

public String getUserSpecifiedSystem()

Indicates the entry's source system that Data Catalog doesn't automatically integrate with.

The user_specified_system string has the following limitations:

• Is case insensitive.
• Must begin with a letter or underscore.
• Can only contain letters, numbers, and underscores.
• 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()

Indicates the entry's source system that Data Catalog doesn't automatically integrate with.

The user_specified_system string has the following limitations:

• Is case insensitive.
• Must begin with a letter or underscore.
• Can only contain letters, numbers, and underscores.
• 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()

Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum.

When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type.

The user_specified_type string has the following limitations:

• Is case insensitive.
• Must begin with a letter or underscore.
• Can only contain letters, numbers, and underscores.
• Must be at least 1 character and at most 64 characters long.

string user_specified_type = 16;

Returns
Type	Description
String	The userSpecifiedType.

getUserSpecifiedTypeBytes()

public ByteString getUserSpecifiedTypeBytes()

Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum.

When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type.

The user_specified_type string has the following limitations:

• Is case insensitive.
• Must begin with a letter or underscore.
• Can only contain letters, numbers, and underscores.
• Must be at least 1 character and at most 64 characters long.

string user_specified_type = 16;

Returns
Type	Description
ByteString	The bytes for userSpecifiedType.

hasBigqueryDateShardedSpec()

public boolean hasBigqueryDateShardedSpec()

Output only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the bigqueryDateShardedSpec field is set.

hasBigqueryTableSpec()

public boolean hasBigqueryTableSpec()

Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the bigqueryTableSpec field is set.

hasBusinessContext()

public boolean hasBusinessContext()

Business Context of the entry. Not supported for BigQuery datasets

.google.cloud.datacatalog.v1.BusinessContext business_context = 37;

Returns
Type	Description
boolean	Whether the businessContext field is set.

hasCloudBigtableSystemSpec()

public boolean hasCloudBigtableSystemSpec()

Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

.google.cloud.datacatalog.v1.CloudBigtableSystemSpec cloud_bigtable_system_spec = 41;

Returns
Type	Description
boolean	Whether the cloudBigtableSystemSpec field is set.

hasDataSource()

public boolean hasDataSource()

Output only. Physical location of the entry.

.google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the dataSource field is set.

hasDataSourceConnectionSpec()

public boolean hasDataSourceConnectionSpec()

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27;

Returns
Type	Description
boolean	Whether the dataSourceConnectionSpec field is set.

hasDatabaseTableSpec()

public boolean hasDatabaseTableSpec()

Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;

Returns
Type	Description
boolean	Whether the databaseTableSpec field is set.

hasDatasetSpec()

public boolean hasDatasetSpec()

Specification that applies to a dataset.

.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;

Returns
Type	Description
boolean	Whether the datasetSpec field is set.

hasFilesetSpec()

public boolean hasFilesetSpec()

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;

Returns
Type	Description
boolean	Whether the filesetSpec field is set.

hasGcsFilesetSpec()

public boolean hasGcsFilesetSpec()

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;

Returns
Type	Description
boolean	Whether the gcsFilesetSpec field is set.

hasIntegratedSystem()

public boolean hasIntegratedSystem()

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the integratedSystem field is set.

hasLookerSystemSpec()

public boolean hasLookerSystemSpec()

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;

Returns
Type	Description
boolean	Whether the lookerSystemSpec field is set.

hasModelSpec()

public boolean hasModelSpec()

Model specification.

.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;

Returns
Type	Description
boolean	Whether the modelSpec field is set.

hasPersonalDetails()

public boolean hasPersonalDetails()

Output only. Additional information related to the entry. Private to the current user.

.google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the personalDetails field is set.

hasRoutineSpec()

public boolean hasRoutineSpec()

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;

Returns
Type	Description
boolean	Whether the routineSpec field is set.

hasSchema()

public boolean hasSchema()

Schema of the entry. An entry might not have any schema attached to it.

.google.cloud.datacatalog.v1.Schema schema = 5;

Returns
Type	Description
boolean	Whether the schema field is set.

hasServiceSpec()

public boolean hasServiceSpec()

Specification that applies to a Service resource.

.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;

Returns
Type	Description
boolean	Whether the serviceSpec field is set.

hasSourceSystemTimestamps()

public boolean hasSourceSystemTimestamps()

Timestamps from the underlying resource, not from the Data Catalog entry.

Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;

Returns
Type	Description
boolean	Whether the sourceSystemTimestamps field is set.

hasSqlDatabaseSystemSpec()

public boolean hasSqlDatabaseSystemSpec()

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;

Returns
Type	Description
boolean	Whether the sqlDatabaseSystemSpec field is set.

hasType()

public boolean hasType()

The type of the entry.

For details, see EntryType.

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

Returns
Type	Description
boolean	Whether the type field is set.

hasUsageSignal()

public boolean hasUsageSignal()

Resource usage statistics.

.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;

Returns
Type	Description
boolean	Whether the usageSignal field is set.

hasUserSpecifiedSystem()

public boolean hasUserSpecifiedSystem()

Indicates the entry's source system that Data Catalog doesn't automatically integrate with.

The user_specified_system string has the following limitations:

• Is case insensitive.
• Must begin with a letter or underscore.
• Can only contain letters, numbers, and underscores.
• 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()

Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum.

When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type.

The user_specified_type string has the following limitations:

• Is case insensitive.
• Must begin with a letter or underscore.
• Can only contain letters, numbers, and underscores.
• Must be at least 1 character and at most 64 characters long.

string user_specified_type = 16;

Returns
Type	Description
boolean	Whether the userSpecifiedType field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

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

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Entry.Builder toBuilder()

Returns
Type	Description
Entry.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException