Class Entry.Builder (1.12.0)

public static final class Entry.Builder extends GeneratedMessageV3.Builder<Entry.Builder> 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

Implements

EntryOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Entry.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Entry.Builder
Overrides

build()

public Entry build()
Returns
TypeDescription
Entry

buildPartial()

public Entry buildPartial()
Returns
TypeDescription
Entry

clear()

public Entry.Builder clear()
Returns
TypeDescription
Entry.Builder
Overrides

clearBigqueryDateShardedSpec()

public Entry.Builder clearBigqueryDateShardedSpec()

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
TypeDescription
Entry.Builder

clearBigqueryTableSpec()

public Entry.Builder clearBigqueryTableSpec()

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
TypeDescription
Entry.Builder

clearBusinessContext()

public Entry.Builder clearBusinessContext()

Business Context of the entry. Not supported for BigQuery datasets

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

Returns
TypeDescription
Entry.Builder

clearDataSource()

public Entry.Builder clearDataSource()

Output only. Physical location of the entry.

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

Returns
TypeDescription
Entry.Builder

clearDataSourceConnectionSpec()

public Entry.Builder clearDataSourceConnectionSpec()

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
TypeDescription
Entry.Builder

clearDatabaseTableSpec()

public Entry.Builder clearDatabaseTableSpec()

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

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

Returns
TypeDescription
Entry.Builder

clearDescription()

public Entry.Builder clearDescription()

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
TypeDescription
Entry.Builder

This builder for chaining.

clearDisplayName()

public Entry.Builder clearDisplayName()

Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string.

string display_name = 3;

Returns
TypeDescription
Entry.Builder

This builder for chaining.

clearEntryType()

public Entry.Builder clearEntryType()
Returns
TypeDescription
Entry.Builder

clearField(Descriptors.FieldDescriptor field)

public Entry.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Entry.Builder
Overrides

clearFilesetSpec()

public Entry.Builder clearFilesetSpec()

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

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

Returns
TypeDescription
Entry.Builder

clearFullyQualifiedName()

public Entry.Builder clearFullyQualifiedName()

Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. FQNs take two forms:

  • For non-regionalized resources: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
  • For regionalized resources: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} Example for a DPMS table: dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

string fully_qualified_name = 29;

Returns
TypeDescription
Entry.Builder

This builder for chaining.

clearGcsFilesetSpec()

public Entry.Builder clearGcsFilesetSpec()

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
TypeDescription
Entry.Builder

clearIntegratedSystem()

public Entry.Builder clearIntegratedSystem()

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
TypeDescription
Entry.Builder

This builder for chaining.

clearLabels()

public Entry.Builder clearLabels()
Returns
TypeDescription
Entry.Builder

clearLinkedResource()

public Entry.Builder clearLinkedResource()

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
TypeDescription
Entry.Builder

This builder for chaining.

clearName()

public Entry.Builder clearName()

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
TypeDescription
Entry.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Entry.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Entry.Builder
Overrides

clearPersonalDetails()

public Entry.Builder clearPersonalDetails()

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
TypeDescription
Entry.Builder

clearRoutineSpec()

public Entry.Builder clearRoutineSpec()

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
TypeDescription
Entry.Builder

clearSchema()

public Entry.Builder clearSchema()

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

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

Returns
TypeDescription
Entry.Builder

clearSourceSystemTimestamps()

public Entry.Builder clearSourceSystemTimestamps()

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
TypeDescription
Entry.Builder

clearSpec()

public Entry.Builder clearSpec()
Returns
TypeDescription
Entry.Builder

clearSystem()

public Entry.Builder clearSystem()
Returns
TypeDescription
Entry.Builder

clearType()

public Entry.Builder clearType()

The type of the entry. Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

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

Returns
TypeDescription
Entry.Builder

This builder for chaining.

clearTypeSpec()

public Entry.Builder clearTypeSpec()
Returns
TypeDescription
Entry.Builder

clearUsageSignal()

public Entry.Builder clearUsageSignal()

Resource usage statistics.

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

Returns
TypeDescription
Entry.Builder

clearUserSpecifiedSystem()

public Entry.Builder clearUserSpecifiedSystem()

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
TypeDescription
Entry.Builder

This builder for chaining.

clearUserSpecifiedType()

public Entry.Builder clearUserSpecifiedType()

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
TypeDescription
Entry.Builder

This builder for chaining.

clone()

public Entry.Builder clone()
Returns
TypeDescription
Entry.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
boolean

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
TypeDescription
BigQueryDateShardedSpec

The bigqueryDateShardedSpec.

getBigqueryDateShardedSpecBuilder()

public BigQueryDateShardedSpec.Builder getBigqueryDateShardedSpecBuilder()

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
TypeDescription
BigQueryDateShardedSpec.Builder

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
TypeDescription
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
TypeDescription
BigQueryTableSpec

The bigqueryTableSpec.

getBigqueryTableSpecBuilder()

public BigQueryTableSpec.Builder getBigqueryTableSpecBuilder()

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
TypeDescription
BigQueryTableSpec.Builder

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
TypeDescription
BigQueryTableSpecOrBuilder

getBusinessContext()

public BusinessContext getBusinessContext()

Business Context of the entry. Not supported for BigQuery datasets

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

Returns
TypeDescription
BusinessContext

The businessContext.

getBusinessContextBuilder()

public BusinessContext.Builder getBusinessContextBuilder()

Business Context of the entry. Not supported for BigQuery datasets

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

Returns
TypeDescription
BusinessContext.Builder

getBusinessContextOrBuilder()

public BusinessContextOrBuilder getBusinessContextOrBuilder()

Business Context of the entry. Not supported for BigQuery datasets

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

Returns
TypeDescription
BusinessContextOrBuilder

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
TypeDescription
DataSource

The dataSource.

getDataSourceBuilder()

public DataSource.Builder getDataSourceBuilder()

Output only. Physical location of the entry.

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

Returns
TypeDescription
DataSource.Builder

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
TypeDescription
DataSourceConnectionSpec

The dataSourceConnectionSpec.

getDataSourceConnectionSpecBuilder()

public DataSourceConnectionSpec.Builder getDataSourceConnectionSpecBuilder()

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
TypeDescription
DataSourceConnectionSpec.Builder

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
TypeDescription
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
TypeDescription
DataSourceOrBuilder

getDatabaseTableSpec()

public DatabaseTableSpec getDatabaseTableSpec()

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

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

Returns
TypeDescription
DatabaseTableSpec

The databaseTableSpec.

getDatabaseTableSpecBuilder()

public DatabaseTableSpec.Builder getDatabaseTableSpecBuilder()

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

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

Returns
TypeDescription
DatabaseTableSpec.Builder

getDatabaseTableSpecOrBuilder()

public DatabaseTableSpecOrBuilder getDatabaseTableSpecOrBuilder()

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

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

Returns
TypeDescription
DatabaseTableSpecOrBuilder

getDefaultInstanceForType()

public Entry getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string.

string display_name = 3;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string.

string display_name = 3;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEntryTypeCase()

public Entry.EntryTypeCase getEntryTypeCase()
Returns
TypeDescription
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
TypeDescription
FilesetSpec

The filesetSpec.

getFilesetSpecBuilder()

public FilesetSpec.Builder getFilesetSpecBuilder()

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

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

Returns
TypeDescription
FilesetSpec.Builder

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
TypeDescription
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 afterwards. Can be used for search and lookup of the entries. FQNs take two forms:

  • For non-regionalized resources: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
  • For regionalized resources: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} Example for a DPMS table: dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

string fully_qualified_name = 29;

Returns
TypeDescription
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 afterwards. Can be used for search and lookup of the entries. FQNs take two forms:

  • For non-regionalized resources: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
  • For regionalized resources: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} Example for a DPMS table: dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

string fully_qualified_name = 29;

Returns
TypeDescription
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
TypeDescription
GcsFilesetSpec

The gcsFilesetSpec.

getGcsFilesetSpecBuilder()

public GcsFilesetSpec.Builder getGcsFilesetSpecBuilder()

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
TypeDescription
GcsFilesetSpec.Builder

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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for integratedSystem.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for linkedResource.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

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
TypeDescription
PersonalDetails

The personalDetails.

getPersonalDetailsBuilder()

public PersonalDetails.Builder getPersonalDetailsBuilder()

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
TypeDescription
PersonalDetails.Builder

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
TypeDescription
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
TypeDescription
RoutineSpec

The routineSpec.

getRoutineSpecBuilder()

public RoutineSpec.Builder getRoutineSpecBuilder()

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
TypeDescription
RoutineSpec.Builder

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
TypeDescription
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
TypeDescription
Schema

The schema.

getSchemaBuilder()

public Schema.Builder getSchemaBuilder()

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

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

Returns
TypeDescription
Schema.Builder

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
TypeDescription
SchemaOrBuilder

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
TypeDescription
SystemTimestamps

The sourceSystemTimestamps.

getSourceSystemTimestampsBuilder()

public SystemTimestamps.Builder getSourceSystemTimestampsBuilder()

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
TypeDescription
SystemTimestamps.Builder

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
TypeDescription
SystemTimestampsOrBuilder

getSpecCase()

public Entry.SpecCase getSpecCase()
Returns
TypeDescription
Entry.SpecCase

getSystemCase()

public Entry.SystemCase getSystemCase()
Returns
TypeDescription
Entry.SystemCase

getType()

public EntryType getType()

The type of the entry. Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

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

Returns
TypeDescription
EntryType

The type.

getTypeSpecCase()

public Entry.TypeSpecCase getTypeSpecCase()
Returns
TypeDescription
Entry.TypeSpecCase

getTypeValue()

public int getTypeValue()

The type of the entry. Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

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

Returns
TypeDescription
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
TypeDescription
UsageSignal

The usageSignal.

getUsageSignalBuilder()

public UsageSignal.Builder getUsageSignalBuilder()

Resource usage statistics.

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

Returns
TypeDescription
UsageSignal.Builder

getUsageSignalOrBuilder()

public UsageSignalOrBuilder getUsageSignalOrBuilder()

Resource usage statistics.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the businessContext 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
TypeDescription
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
TypeDescription
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 type.

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

Returns
TypeDescription
boolean

Whether the databaseTableSpec 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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the integratedSystem 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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the schema 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
TypeDescription
boolean

Whether the sourceSystemTimestamps field is set.

hasType()

public boolean hasType()

The type of the entry. Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

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

Returns
TypeDescription
boolean

Whether the type field is set.

hasUsageSignal()

public boolean hasUsageSignal()

Resource usage statistics.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the userSpecifiedType field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBigqueryDateShardedSpec(BigQueryDateShardedSpec value)

public Entry.Builder mergeBigqueryDateShardedSpec(BigQueryDateShardedSpec value)

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

Parameter
NameDescription
valueBigQueryDateShardedSpec
Returns
TypeDescription
Entry.Builder

mergeBigqueryTableSpec(BigQueryTableSpec value)

public Entry.Builder mergeBigqueryTableSpec(BigQueryTableSpec value)

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

Parameter
NameDescription
valueBigQueryTableSpec
Returns
TypeDescription
Entry.Builder

mergeBusinessContext(BusinessContext value)

public Entry.Builder mergeBusinessContext(BusinessContext value)

Business Context of the entry. Not supported for BigQuery datasets

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

Parameter
NameDescription
valueBusinessContext
Returns
TypeDescription
Entry.Builder

mergeDataSource(DataSource value)

public Entry.Builder mergeDataSource(DataSource value)

Output only. Physical location of the entry.

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

Parameter
NameDescription
valueDataSource
Returns
TypeDescription
Entry.Builder

mergeDataSourceConnectionSpec(DataSourceConnectionSpec value)

public Entry.Builder mergeDataSourceConnectionSpec(DataSourceConnectionSpec value)

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;

Parameter
NameDescription
valueDataSourceConnectionSpec
Returns
TypeDescription
Entry.Builder

mergeDatabaseTableSpec(DatabaseTableSpec value)

public Entry.Builder mergeDatabaseTableSpec(DatabaseTableSpec value)

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

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

Parameter
NameDescription
valueDatabaseTableSpec
Returns
TypeDescription
Entry.Builder

mergeFilesetSpec(FilesetSpec value)

public Entry.Builder mergeFilesetSpec(FilesetSpec value)

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

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

Parameter
NameDescription
valueFilesetSpec
Returns
TypeDescription
Entry.Builder

mergeFrom(Entry other)

public Entry.Builder mergeFrom(Entry other)
Parameter
NameDescription
otherEntry
Returns
TypeDescription
Entry.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Entry.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Entry.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Entry.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Entry.Builder
Overrides

mergeGcsFilesetSpec(GcsFilesetSpec value)

public Entry.Builder mergeGcsFilesetSpec(GcsFilesetSpec value)

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;

Parameter
NameDescription
valueGcsFilesetSpec
Returns
TypeDescription
Entry.Builder

mergePersonalDetails(PersonalDetails value)

public Entry.Builder mergePersonalDetails(PersonalDetails value)

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

Parameter
NameDescription
valuePersonalDetails
Returns
TypeDescription
Entry.Builder

mergeRoutineSpec(RoutineSpec value)

public Entry.Builder mergeRoutineSpec(RoutineSpec value)

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;

Parameter
NameDescription
valueRoutineSpec
Returns
TypeDescription
Entry.Builder

mergeSchema(Schema value)

public Entry.Builder mergeSchema(Schema value)

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

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

Parameter
NameDescription
valueSchema
Returns
TypeDescription
Entry.Builder

mergeSourceSystemTimestamps(SystemTimestamps value)

public Entry.Builder mergeSourceSystemTimestamps(SystemTimestamps value)

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;

Parameter
NameDescription
valueSystemTimestamps
Returns
TypeDescription
Entry.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Entry.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Entry.Builder
Overrides

mergeUsageSignal(UsageSignal value)

public Entry.Builder mergeUsageSignal(UsageSignal value)

Resource usage statistics.

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

Parameter
NameDescription
valueUsageSignal
Returns
TypeDescription
Entry.Builder

putAllLabels(Map<String,String> values)

public Entry.Builder putAllLabels(Map<String,String> values)

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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Entry.Builder

putLabels(String key, String value)

public Entry.Builder putLabels(String key, String value)

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
NameDescription
keyString
valueString
Returns
TypeDescription
Entry.Builder

removeLabels(String key)

public Entry.Builder removeLabels(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
NameDescription
keyString
Returns
TypeDescription
Entry.Builder

setBigqueryDateShardedSpec(BigQueryDateShardedSpec value)

public Entry.Builder setBigqueryDateShardedSpec(BigQueryDateShardedSpec value)

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

Parameter
NameDescription
valueBigQueryDateShardedSpec
Returns
TypeDescription
Entry.Builder

setBigqueryDateShardedSpec(BigQueryDateShardedSpec.Builder builderForValue)

public Entry.Builder setBigqueryDateShardedSpec(BigQueryDateShardedSpec.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBigQueryDateShardedSpec.Builder
Returns
TypeDescription
Entry.Builder

setBigqueryTableSpec(BigQueryTableSpec value)

public Entry.Builder setBigqueryTableSpec(BigQueryTableSpec value)

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

Parameter
NameDescription
valueBigQueryTableSpec
Returns
TypeDescription
Entry.Builder

setBigqueryTableSpec(BigQueryTableSpec.Builder builderForValue)

public Entry.Builder setBigqueryTableSpec(BigQueryTableSpec.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBigQueryTableSpec.Builder
Returns
TypeDescription
Entry.Builder

setBusinessContext(BusinessContext value)

public Entry.Builder setBusinessContext(BusinessContext value)

Business Context of the entry. Not supported for BigQuery datasets

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

Parameter
NameDescription
valueBusinessContext
Returns
TypeDescription
Entry.Builder

setBusinessContext(BusinessContext.Builder builderForValue)

public Entry.Builder setBusinessContext(BusinessContext.Builder builderForValue)

Business Context of the entry. Not supported for BigQuery datasets

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

Parameter
NameDescription
builderForValueBusinessContext.Builder
Returns
TypeDescription
Entry.Builder

setDataSource(DataSource value)

public Entry.Builder setDataSource(DataSource value)

Output only. Physical location of the entry.

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

Parameter
NameDescription
valueDataSource
Returns
TypeDescription
Entry.Builder

setDataSource(DataSource.Builder builderForValue)

public Entry.Builder setDataSource(DataSource.Builder builderForValue)

Output only. Physical location of the entry.

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

Parameter
NameDescription
builderForValueDataSource.Builder
Returns
TypeDescription
Entry.Builder

setDataSourceConnectionSpec(DataSourceConnectionSpec value)

public Entry.Builder setDataSourceConnectionSpec(DataSourceConnectionSpec value)

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;

Parameter
NameDescription
valueDataSourceConnectionSpec
Returns
TypeDescription
Entry.Builder

setDataSourceConnectionSpec(DataSourceConnectionSpec.Builder builderForValue)

public Entry.Builder setDataSourceConnectionSpec(DataSourceConnectionSpec.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueDataSourceConnectionSpec.Builder
Returns
TypeDescription
Entry.Builder

setDatabaseTableSpec(DatabaseTableSpec value)

public Entry.Builder setDatabaseTableSpec(DatabaseTableSpec value)

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

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

Parameter
NameDescription
valueDatabaseTableSpec
Returns
TypeDescription
Entry.Builder

setDatabaseTableSpec(DatabaseTableSpec.Builder builderForValue)

public Entry.Builder setDatabaseTableSpec(DatabaseTableSpec.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueDatabaseTableSpec.Builder
Returns
TypeDescription
Entry.Builder

setDescription(String value)

public Entry.Builder setDescription(String value)

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;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Entry.Builder setDescriptionBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setDisplayName(String value)

public Entry.Builder setDisplayName(String value)

Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string.

string display_name = 3;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Entry.Builder setDisplayNameBytes(ByteString value)

Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string.

string display_name = 3;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Entry.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Entry.Builder
Overrides

setFilesetSpec(FilesetSpec value)

public Entry.Builder setFilesetSpec(FilesetSpec value)

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

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

Parameter
NameDescription
valueFilesetSpec
Returns
TypeDescription
Entry.Builder

setFilesetSpec(FilesetSpec.Builder builderForValue)

public Entry.Builder setFilesetSpec(FilesetSpec.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueFilesetSpec.Builder
Returns
TypeDescription
Entry.Builder

setFullyQualifiedName(String value)

public Entry.Builder setFullyQualifiedName(String value)

Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. FQNs take two forms:

  • For non-regionalized resources: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
  • For regionalized resources: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} Example for a DPMS table: dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

string fully_qualified_name = 29;

Parameter
NameDescription
valueString

The fullyQualifiedName to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setFullyQualifiedNameBytes(ByteString value)

public Entry.Builder setFullyQualifiedNameBytes(ByteString value)

Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. FQNs take two forms:

  • For non-regionalized resources: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
  • For regionalized resources: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} Example for a DPMS table: dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

string fully_qualified_name = 29;

Parameter
NameDescription
valueByteString

The bytes for fullyQualifiedName to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setGcsFilesetSpec(GcsFilesetSpec value)

public Entry.Builder setGcsFilesetSpec(GcsFilesetSpec value)

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;

Parameter
NameDescription
valueGcsFilesetSpec
Returns
TypeDescription
Entry.Builder

setGcsFilesetSpec(GcsFilesetSpec.Builder builderForValue)

public Entry.Builder setGcsFilesetSpec(GcsFilesetSpec.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueGcsFilesetSpec.Builder
Returns
TypeDescription
Entry.Builder

setIntegratedSystem(IntegratedSystem value)

public Entry.Builder setIntegratedSystem(IntegratedSystem value)

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

Parameter
NameDescription
valueIntegratedSystem

The integratedSystem to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setIntegratedSystemValue(int value)

public Entry.Builder setIntegratedSystemValue(int value)

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for integratedSystem to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setLinkedResource(String value)

public Entry.Builder setLinkedResource(String value)

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;

Parameter
NameDescription
valueString

The linkedResource to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setLinkedResourceBytes(ByteString value)

public Entry.Builder setLinkedResourceBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for linkedResource to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setName(String value)

public Entry.Builder setName(String value)

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Entry.Builder setNameBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setPersonalDetails(PersonalDetails value)

public Entry.Builder setPersonalDetails(PersonalDetails value)

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

Parameter
NameDescription
valuePersonalDetails
Returns
TypeDescription
Entry.Builder

setPersonalDetails(PersonalDetails.Builder builderForValue)

public Entry.Builder setPersonalDetails(PersonalDetails.Builder builderForValue)

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

Parameter
NameDescription
builderForValuePersonalDetails.Builder
Returns
TypeDescription
Entry.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Entry.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Entry.Builder
Overrides

setRoutineSpec(RoutineSpec value)

public Entry.Builder setRoutineSpec(RoutineSpec value)

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;

Parameter
NameDescription
valueRoutineSpec
Returns
TypeDescription
Entry.Builder

setRoutineSpec(RoutineSpec.Builder builderForValue)

public Entry.Builder setRoutineSpec(RoutineSpec.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueRoutineSpec.Builder
Returns
TypeDescription
Entry.Builder

setSchema(Schema value)

public Entry.Builder setSchema(Schema value)

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

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

Parameter
NameDescription
valueSchema
Returns
TypeDescription
Entry.Builder

setSchema(Schema.Builder builderForValue)

public Entry.Builder setSchema(Schema.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueSchema.Builder
Returns
TypeDescription
Entry.Builder

setSourceSystemTimestamps(SystemTimestamps value)

public Entry.Builder setSourceSystemTimestamps(SystemTimestamps value)

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;

Parameter
NameDescription
valueSystemTimestamps
Returns
TypeDescription
Entry.Builder

setSourceSystemTimestamps(SystemTimestamps.Builder builderForValue)

public Entry.Builder setSourceSystemTimestamps(SystemTimestamps.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueSystemTimestamps.Builder
Returns
TypeDescription
Entry.Builder

setType(EntryType value)

public Entry.Builder setType(EntryType value)

The type of the entry. Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

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

Parameter
NameDescription
valueEntryType

The type to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setTypeValue(int value)

public Entry.Builder setTypeValue(int value)

The type of the entry. Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for type to set.

Returns
TypeDescription
Entry.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Entry.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Entry.Builder
Overrides

setUsageSignal(UsageSignal value)

public Entry.Builder setUsageSignal(UsageSignal value)

Resource usage statistics.

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

Parameter
NameDes