- 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 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Entry.BuilderImplements
EntryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Entry.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
build()
public Entry build()| Returns | |
|---|---|
| Type | Description |
Entry |
|
buildPartial()
public Entry buildPartial()| Returns | |
|---|---|
| Type | Description |
Entry |
|
clear()
public Entry.Builder clear()| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearCloudBigtableSystemSpec()
public Entry.Builder clearCloudBigtableSystemSpec() 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 |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearDatabaseTableSpec()
public Entry.Builder clearDatabaseTableSpec() 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 |
Entry.Builder |
|
clearDatasetSpec()
public Entry.Builder clearDatasetSpec()Specification that applies to a dataset.
.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
clearDisplayName()
public Entry.Builder clearDisplayName()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 |
Entry.Builder |
This builder for chaining. |
clearEntryType()
public Entry.Builder clearEntryType()| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Entry.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 | |
|---|---|
| Type | Description |
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 later. Can be used for search and lookup of the entries.
string fully_qualified_name = 29;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
clearLabels()
public Entry.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
clearLookerSystemSpec()
public Entry.Builder clearLookerSystemSpec() 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 |
Entry.Builder |
|
clearModelSpec()
public Entry.Builder clearModelSpec()Model specification.
.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Entry.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearServiceSpec()
public Entry.Builder clearServiceSpec()Specification that applies to a Service resource.
.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearSpec()
public Entry.Builder clearSpec()| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearSqlDatabaseSystemSpec()
public Entry.Builder clearSqlDatabaseSystemSpec() 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 |
Entry.Builder |
|
clearSystem()
public Entry.Builder clearSystem()| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearSystemSpec()
public Entry.Builder clearSystemSpec()| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearType()
public Entry.Builder clearType()| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
clearTypeSpec()
public Entry.Builder clearTypeSpec()| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
clearUsageSignal()
public Entry.Builder clearUsageSignal()Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
clone()
public Entry.Builder clone()| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 |
|
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
getBusinessContextBuilder()
public BusinessContext.Builder getBusinessContextBuilder()Business Context of the entry. Not supported for BigQuery datasets
.google.cloud.datacatalog.v1.BusinessContext business_context = 37;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
getCloudBigtableSystemSpecBuilder()
public CloudBigtableSystemSpec.Builder getCloudBigtableSystemSpecBuilder() 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.Builder |
|
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
getDatabaseTableSpecBuilder()
public DatabaseTableSpec.Builder getDatabaseTableSpecBuilder() 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.Builder |
|
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. |
getDatasetSpecBuilder()
public DatasetSpec.Builder getDatasetSpecBuilder()Specification that applies to a dataset.
.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;
| Returns | |
|---|---|
| Type | Description |
DatasetSpec.Builder |
|
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
getLookerSystemSpecBuilder()
public LookerSystemSpec.Builder getLookerSystemSpecBuilder() 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.Builder |
|
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. |
getModelSpecBuilder()
public ModelSpec.Builder getModelSpecBuilder()Model specification.
.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;
| Returns | |
|---|---|
| Type | Description |
ModelSpec.Builder |
|
getModelSpecOrBuilder()
public ModelSpecOrBuilder getModelSpecOrBuilder()Model specification.
.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;
| Returns | |
|---|---|
| Type | Description |
ModelSpecOrBuilder |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
SchemaOrBuilder |
|
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. |
getServiceSpecBuilder()
public ServiceSpec.Builder getServiceSpecBuilder()Specification that applies to a Service resource.
.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;
| Returns | |
|---|---|
| Type | Description |
ServiceSpec.Builder |
|
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
getSqlDatabaseSystemSpecBuilder()
public SqlDatabaseSystemSpec.Builder getSqlDatabaseSystemSpecBuilder() 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.Builder |
|
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()| Returns | |
|---|---|
| Type | Description |
EntryType |
The type. |
getTypeSpecCase()
public Entry.TypeSpecCase getTypeSpecCase()| Returns | |
|---|---|
| Type | Description |
Entry.TypeSpecCase |
|
getTypeValue()
public int getTypeValue()| 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. |
getUsageSignalBuilder()
public UsageSignal.Builder getUsageSignalBuilder()Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;
| Returns | |
|---|---|
| Type | Description |
UsageSignal.Builder |
|
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()| 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 | |
|---|---|
| Name | Description |
value |
BigQueryDateShardedSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
BigQueryTableSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
BusinessContext |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeCloudBigtableSystemSpec(CloudBigtableSystemSpec value)
public Entry.Builder mergeCloudBigtableSystemSpec(CloudBigtableSystemSpec value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
CloudBigtableSystemSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
DataSource |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
DataSourceConnectionSpec |
| Returns | |
|---|---|
| Type | Description |
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 or EXPLORE type.
.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseTableSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeDatasetSpec(DatasetSpec value)
public Entry.Builder mergeDatasetSpec(DatasetSpec value)Specification that applies to a dataset.
.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;
| Parameter | |
|---|---|
| Name | Description |
value |
DatasetSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
FilesetSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeFrom(Entry other)
public Entry.Builder mergeFrom(Entry other)| Parameter | |
|---|---|
| Name | Description |
other |
Entry |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Entry.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Entry.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
GcsFilesetSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeLookerSystemSpec(LookerSystemSpec value)
public Entry.Builder mergeLookerSystemSpec(LookerSystemSpec value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
LookerSystemSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeModelSpec(ModelSpec value)
public Entry.Builder mergeModelSpec(ModelSpec value)Model specification.
.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;
| Parameter | |
|---|---|
| Name | Description |
value |
ModelSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
PersonalDetails |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
RoutineSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
Schema |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeServiceSpec(ServiceSpec value)
public Entry.Builder mergeServiceSpec(ServiceSpec value)Specification that applies to a Service resource.
.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;
| Parameter | |
|---|---|
| Name | Description |
value |
ServiceSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
SystemTimestamps |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeSqlDatabaseSystemSpec(SqlDatabaseSystemSpec value)
public Entry.Builder mergeSqlDatabaseSystemSpec(SqlDatabaseSystemSpec value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
SqlDatabaseSystemSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Entry.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
mergeUsageSignal(UsageSignal value)
public Entry.Builder mergeUsageSignal(UsageSignal value)Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
UsageSignal |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
BigQueryDateShardedSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
BigQueryDateShardedSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
BigQueryTableSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
BigQueryTableSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
BusinessContext |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
BusinessContext.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setCloudBigtableSystemSpec(CloudBigtableSystemSpec value)
public Entry.Builder setCloudBigtableSystemSpec(CloudBigtableSystemSpec value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
CloudBigtableSystemSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setCloudBigtableSystemSpec(CloudBigtableSystemSpec.Builder builderForValue)
public Entry.Builder setCloudBigtableSystemSpec(CloudBigtableSystemSpec.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CloudBigtableSystemSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
DataSource |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
DataSource.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
DataSourceConnectionSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
DataSourceConnectionSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 or EXPLORE type.
.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseTableSpec |
| Returns | |
|---|---|
| Type | Description |
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 or EXPLORE type.
.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DatabaseTableSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setDatasetSpec(DatasetSpec value)
public Entry.Builder setDatasetSpec(DatasetSpec value)Specification that applies to a dataset.
.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;
| Parameter | |
|---|---|
| Name | Description |
value |
DatasetSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setDatasetSpec(DatasetSpec.Builder builderForValue)
public Entry.Builder setDatasetSpec(DatasetSpec.Builder builderForValue)Specification that applies to a dataset.
.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DatasetSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setDisplayName(String value)
public Entry.Builder setDisplayName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Entry.Builder setDisplayNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Entry.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
FilesetSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
FilesetSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 later. Can be used for search and lookup of the entries.
string fully_qualified_name = 29;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe fullyQualifiedName to set. |
| Returns | |
|---|---|
| Type | Description |
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 later. Can be used for search and lookup of the entries.
string fully_qualified_name = 29;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for fullyQualifiedName to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
GcsFilesetSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
GcsFilesetSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
IntegratedSystemThe integratedSystem to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for integratedSystem to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe linkedResource to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for linkedResource to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setLookerSystemSpec(LookerSystemSpec value)
public Entry.Builder setLookerSystemSpec(LookerSystemSpec value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
LookerSystemSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setLookerSystemSpec(LookerSystemSpec.Builder builderForValue)
public Entry.Builder setLookerSystemSpec(LookerSystemSpec.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
LookerSystemSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setModelSpec(ModelSpec value)
public Entry.Builder setModelSpec(ModelSpec value)Model specification.
.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;
| Parameter | |
|---|---|
| Name | Description |
value |
ModelSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setModelSpec(ModelSpec.Builder builderForValue)
public Entry.Builder setModelSpec(ModelSpec.Builder builderForValue)Model specification.
.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ModelSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
PersonalDetails |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
PersonalDetails.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Entry.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
RoutineSpec |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
RoutineSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
Schema |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Schema.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setServiceSpec(ServiceSpec value)
public Entry.Builder setServiceSpec(ServiceSpec value)Specification that applies to a Service resource.
.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;
| Parameter | |
|---|---|
| Name | Description |
value |
ServiceSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setServiceSpec(ServiceSpec.Builder builderForValue)
public Entry.Builder setServiceSpec(ServiceSpec.Builder builderForValue)Specification that applies to a Service resource.
.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ServiceSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
SystemTimestamps |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
SystemTimestamps.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setSqlDatabaseSystemSpec(SqlDatabaseSystemSpec value)
public Entry.Builder setSqlDatabaseSystemSpec(SqlDatabaseSystemSpec value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
SqlDatabaseSystemSpec |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setSqlDatabaseSystemSpec(SqlDatabaseSystemSpec.Builder builderForValue)
public Entry.Builder setSqlDatabaseSystemSpec(SqlDatabaseSystemSpec.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SqlDatabaseSystemSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setType(EntryType value)
public Entry.Builder setType(EntryType value)| Parameter | |
|---|---|
| Name | Description |
value |
EntryTypeThe type to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setTypeValue(int value)
public Entry.Builder setTypeValue(int value)| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for type to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Entry.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setUsageSignal(UsageSignal value)
public Entry.Builder setUsageSignal(UsageSignal value)Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
UsageSignal |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setUsageSignal(UsageSignal.Builder builderForValue)
public Entry.Builder setUsageSignal(UsageSignal.Builder builderForValue)Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UsageSignal.Builder |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
|
setUserSpecifiedSystem(String value)
public Entry.Builder setUserSpecifiedSystem(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe userSpecifiedSystem to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setUserSpecifiedSystemBytes(ByteString value)
public Entry.Builder setUserSpecifiedSystemBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for userSpecifiedSystem to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setUserSpecifiedType(String value)
public Entry.Builder setUserSpecifiedType(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe userSpecifiedType to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |
setUserSpecifiedTypeBytes(ByteString value)
public Entry.Builder setUserSpecifiedTypeBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for userSpecifiedType to set. |
| Returns | |
|---|---|
| Type | Description |
Entry.Builder |
This builder for chaining. |