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][google.cloud.datacatalog.v1.Tag].
Protobuf type google.cloud.datacatalog.v1.Entry
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Entry.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Entry buildPartial()
Returns
clear()
public Entry.Builder clear()
Returns
Overrides
clearBigqueryDateShardedSpec()
public Entry.Builder clearBigqueryDateShardedSpec()
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
name pattern.
For more information, see [Introduction to partitioned tables]
(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
Returns
clearBigqueryTableSpec()
public Entry.Builder clearBigqueryTableSpec()
Specification that applies to a BigQuery table. Valid only for
entries with the `TABLE` type.
.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;
Returns
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
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
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
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
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
clearEntryType()
public Entry.Builder clearEntryType()
Returns
clearField(Descriptors.FieldDescriptor field)
public Entry.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
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
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
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
clearLabels()
public Entry.Builder clearLabels()
Returns
clearLinkedResource()
public Entry.Builder clearLinkedResource()
The resource this metadata entry refers to.
For Google Cloud Platform resources, `linked_resource` is the
[Full Resource Name]
(https://cloud.google.com/apis/design/resource_names#full_resource_name).
For example, the `linked_resource` for a table resource from BigQuery is:
`//bigquery.googleapis.com/projects/{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
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
clearOneof(Descriptors.OneofDescriptor oneof)
public Entry.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
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
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
clearSourceSystemTimestamps()
public Entry.Builder clearSourceSystemTimestamps()
Timestamps from the underlying resource, not from the Data Catalog
entry.
Output only when the entry has a type listed in the `EntryType` enum.
For entries with `user_specified_type`, this field is optional and defaults
to an empty timestamp.
.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;
Returns
clearSpec()
public Entry.Builder clearSpec()
Returns
clearSystem()
public Entry.Builder clearSystem()
Returns
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
clearTypeSpec()
public Entry.Builder clearTypeSpec()
Returns
clearUsageSignal()
public Entry.Builder clearUsageSignal()
Output only. Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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
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
clone()
public Entry.Builder clone()
Returns
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
Returns
getBigqueryDateShardedSpec()
public BigQueryDateShardedSpec getBigqueryDateShardedSpec()
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
name pattern.
For more information, see [Introduction to partitioned tables]
(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
Returns
getBigqueryDateShardedSpecBuilder()
public BigQueryDateShardedSpec.Builder getBigqueryDateShardedSpecBuilder()
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
name pattern.
For more information, see [Introduction to partitioned tables]
(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
Returns
getBigqueryDateShardedSpecOrBuilder()
public BigQueryDateShardedSpecOrBuilder getBigqueryDateShardedSpecOrBuilder()
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
name pattern.
For more information, see [Introduction to partitioned tables]
(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
Returns
getBigqueryTableSpec()
public BigQueryTableSpec getBigqueryTableSpec()
Specification that applies to a BigQuery table. Valid only for
entries with the `TABLE` type.
.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;
Returns
getBigqueryTableSpecBuilder()
public BigQueryTableSpec.Builder getBigqueryTableSpecBuilder()
Specification that applies to a BigQuery table. Valid only for
entries with the `TABLE` type.
.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;
Returns
getBigqueryTableSpecOrBuilder()
public BigQueryTableSpecOrBuilder getBigqueryTableSpecOrBuilder()
Specification that applies to a BigQuery table. Valid only for
entries with the `TABLE` type.
.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;
Returns
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
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
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
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
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
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
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
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
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
getDefaultInstanceForType()
public Entry getDefaultInstanceForType()
Returns
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.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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
Type | Description |
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
Type | Description |
ByteString | The bytes for displayName.
|
getEntryTypeCase()
public Entry.EntryTypeCase getEntryTypeCase()
Returns
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
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 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
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
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
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
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
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()
public Map<String,String> getLabels()
Returns
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
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
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
Returns
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
Returns
getLinkedResource()
public String getLinkedResource()
The resource this metadata entry refers to.
For Google Cloud Platform resources, `linked_resource` is the
[Full Resource Name]
(https://cloud.google.com/apis/design/resource_names#full_resource_name).
For example, the `linked_resource` for a table resource from BigQuery is:
`//bigquery.googleapis.com/projects/{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]
(https://cloud.google.com/apis/design/resource_names#full_resource_name).
For example, the `linked_resource` for a table resource from BigQuery is:
`//bigquery.googleapis.com/projects/{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.
|
getMutableLabels()
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns
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
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
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
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
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
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
getSourceSystemTimestamps()
public SystemTimestamps getSourceSystemTimestamps()
Timestamps from the underlying resource, not from the Data Catalog
entry.
Output only when the entry has a type listed in the `EntryType` enum.
For entries with `user_specified_type`, this field is optional and defaults
to an empty timestamp.
.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;
Returns
getSourceSystemTimestampsBuilder()
public SystemTimestamps.Builder getSourceSystemTimestampsBuilder()
Timestamps from the underlying resource, not from the Data Catalog
entry.
Output only when the entry has a type listed in the `EntryType` enum.
For entries with `user_specified_type`, this field is optional and defaults
to an empty timestamp.
.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;
Returns
getSourceSystemTimestampsOrBuilder()
public SystemTimestampsOrBuilder getSourceSystemTimestampsOrBuilder()
Timestamps from the underlying resource, not from the Data Catalog
entry.
Output only when the entry has a type listed in the `EntryType` enum.
For entries with `user_specified_type`, this field is optional and defaults
to an empty timestamp.
.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;
Returns
getSpecCase()
public Entry.SpecCase getSpecCase()
Returns
getSystemCase()
public Entry.SystemCase getSystemCase()
Returns
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
getTypeSpecCase()
public Entry.TypeSpecCase getTypeSpecCase()
Returns
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
Type | Description |
int | The enum numeric value on the wire for type.
|
getUsageSignal()
public UsageSignal getUsageSignal()
Output only. Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getUsageSignalBuilder()
public UsageSignal.Builder getUsageSignalBuilder()
Output only. Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getUsageSignalOrBuilder()
public UsageSignalOrBuilder getUsageSignalOrBuilder()
Output only. Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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()
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
name pattern.
For more information, see [Introduction to partitioned tables]
(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
Returns
Type | Description |
boolean | Whether the bigqueryDateShardedSpec field is set.
|
hasBigqueryTableSpec()
public boolean hasBigqueryTableSpec()
Specification that applies to a BigQuery table. Valid only for
entries with the `TABLE` type.
.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;
Returns
Type | Description |
boolean | Whether the bigqueryTableSpec 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` type.
.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;
Returns
Type | Description |
boolean | Whether the databaseTableSpec 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.
|
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.
|
hasSourceSystemTimestamps()
public boolean hasSourceSystemTimestamps()
Timestamps from the underlying resource, not from the Data Catalog
entry.
Output only when the entry has a type listed in the `EntryType` enum.
For entries with `user_specified_type`, 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.
|
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
Type | Description |
boolean | Whether the type field is set.
|
hasUsageSignal()
public boolean hasUsageSignal()
Output only. Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
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
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeBigqueryDateShardedSpec(BigQueryDateShardedSpec value)
public Entry.Builder mergeBigqueryDateShardedSpec(BigQueryDateShardedSpec value)
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
name pattern.
For more information, see [Introduction to partitioned tables]
(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
Parameter
Returns
mergeBigqueryTableSpec(BigQueryTableSpec value)
public Entry.Builder mergeBigqueryTableSpec(BigQueryTableSpec value)
Specification that applies to a BigQuery table. Valid only for
entries with the `TABLE` type.
.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;
Parameter
Returns
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
Returns
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
Returns
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
Returns
mergeFrom(Entry other)
public Entry.Builder mergeFrom(Entry other)
Parameter
Name | Description |
other | Entry
|
Returns
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Entry.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Entry.Builder mergeFrom(Message other)
Parameter
Returns
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
Returns
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
Returns
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
Returns
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 type listed in the `EntryType` enum.
For entries with `user_specified_type`, this field is optional and defaults
to an empty timestamp.
.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;
Parameter
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Entry.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
mergeUsageSignal(UsageSignal value)
public Entry.Builder mergeUsageSignal(UsageSignal value)
Output only. Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Returns
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
Returns
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
Returns
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
Returns
setBigqueryDateShardedSpec(BigQueryDateShardedSpec value)
public Entry.Builder setBigqueryDateShardedSpec(BigQueryDateShardedSpec value)
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
name pattern.
For more information, see [Introduction to partitioned tables]
(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
Parameter
Returns
setBigqueryDateShardedSpec(BigQueryDateShardedSpec.Builder builderForValue)
public Entry.Builder setBigqueryDateShardedSpec(BigQueryDateShardedSpec.Builder builderForValue)
Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD`
name pattern.
For more information, see [Introduction to partitioned tables]
(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
Parameter
Returns
setBigqueryTableSpec(BigQueryTableSpec value)
public Entry.Builder setBigqueryTableSpec(BigQueryTableSpec value)
Specification that applies to a BigQuery table. Valid only for
entries with the `TABLE` type.
.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;
Parameter
Returns
setBigqueryTableSpec(BigQueryTableSpec.Builder builderForValue)
public Entry.Builder setBigqueryTableSpec(BigQueryTableSpec.Builder builderForValue)
Specification that applies to a BigQuery table. Valid only for
entries with the `TABLE` type.
.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;
Parameter
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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 | String
The description to set.
|
Returns
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 | ByteString
The bytes for description to set.
|
Returns
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
Name | Description |
value | String
The displayName to set.
|
Returns
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
Name | Description |
value | ByteString
The bytes for displayName to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Entry.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
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
Name | Description |
value | String
The fullyQualifiedName to set.
|
Returns
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
Name | Description |
value | ByteString
The bytes for fullyQualifiedName to set.
|
Returns
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
Returns
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
Returns
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
Returns
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 | int
The enum numeric value on the wire for integratedSystem to set.
|
Returns
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]
(https://cloud.google.com/apis/design/resource_names#full_resource_name).
For example, the `linked_resource` for a table resource from BigQuery is:
`//bigquery.googleapis.com/projects/{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 | String
The linkedResource to set.
|
Returns
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]
(https://cloud.google.com/apis/design/resource_names#full_resource_name).
For example, the `linked_resource` for a table resource from BigQuery is:
`//bigquery.googleapis.com/projects/{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 | ByteString
The bytes for linkedResource to set.
|
Returns
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 | String
The name to set.
|
Returns
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 | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Entry.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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 type listed in the `EntryType` enum.
For entries with `user_specified_type`, this field is optional and defaults
to an empty timestamp.
.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;
Parameter
Returns
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 type listed in the `EntryType` enum.
For entries with `user_specified_type`, this field is optional and defaults
to an empty timestamp.
.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;
Parameter
Returns
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
Name | Description |
value | EntryType
The type to set.
|
Returns
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
Name | Description |
value | int
The enum numeric value on the wire for type to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final Entry.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setUsageSignal(UsageSignal value)
public Entry.Builder setUsageSignal(UsageSignal value)
Output only. Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Returns
setUsageSignal(UsageSignal.Builder builderForValue)
public Entry.Builder setUsageSignal(UsageSignal.Builder builderForValue)
Output only. Resource usage statistics.
.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Returns
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 | String
The userSpecifiedSystem to set.
|
Returns
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 | ByteString
The bytes for userSpecifiedSystem to set.
|
Returns
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 | String
The userSpecifiedType to set.
|
Returns
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 | ByteString
The bytes for userSpecifiedType to set.
|
Returns