Class Entry.Builder (1.48.0) 

public static final class Entry.Builder extends GeneratedMessageV3.Builder<Entry.Builder> implements EntryOrBuilder

Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or outside of Google Cloud Platform. Clients can use the linked_resource field in the Entry resource to refer to the original resource ID of the source system.

An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.

Protobuf type google.cloud.datacatalog.v1beta1.Entry

Inheritance

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

Implements

EntryOrBuilder

Static 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
Overrides

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
Overrides

clearBigqueryDateShardedSpec()

public Entry.Builder clearBigqueryDateShardedSpec()

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;

Returns
Type Description
Entry.Builder

clearBigqueryTableSpec()

public Entry.Builder clearBigqueryTableSpec()

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;

Returns
Type Description
Entry.Builder

clearDescription()

public Entry.Builder clearDescription()

Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.

string description = 4;

Returns
Type Description
Entry.Builder

This builder for chaining.

clearDisplayName()

public Entry.Builder clearDisplayName()

Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.

string display_name = 3;

Returns
Type Description
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
Overrides

clearGcsFilesetSpec()

public Entry.Builder clearGcsFilesetSpec()

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

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

Returns
Type Description
Entry.Builder

clearIntegratedSystem()

public Entry.Builder clearIntegratedSystem()

Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

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

Returns
Type Description
Entry.Builder

This builder for chaining.

clearLinkedResource()

public Entry.Builder clearLinkedResource()

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

    Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.

string linked_resource = 9;

Returns
Type Description
Entry.Builder

This builder for chaining.

clearName()

public Entry.Builder clearName()

Output only. The Data Catalog resource name of the entry in URL format. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

    Note that this Entry and its child resources may not actually be stored in the location in this name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.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
Overrides

clearSchema()

public Entry.Builder clearSchema()

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

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

Returns
Type Description
Entry.Builder

clearSourceSystemTimestamps()

public Entry.Builder clearSourceSystemTimestamps()

Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Entry.Builder

clearSystem()

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

clearType()

public Entry.Builder clearType()

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

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

Returns
Type Description
Entry.Builder

This builder for chaining.

clearTypeSpec()

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

clearUsageSignal()

public Entry.Builder clearUsageSignal()

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

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

Returns
Type Description
Entry.Builder

clearUserSpecifiedSystem()

public Entry.Builder clearUserSpecifiedSystem()

This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Returns
Type Description
Entry.Builder

This builder for chaining.

clearUserSpecifiedType()

public Entry.Builder clearUserSpecifiedType()

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.

string user_specified_type = 16;

Returns
Type Description
Entry.Builder

This builder for chaining.

clone()

public Entry.Builder clone()
Returns
Type Description
Entry.Builder
Overrides

getBigqueryDateShardedSpec()

public BigQueryDateShardedSpec getBigqueryDateShardedSpec()

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;

Returns
Type Description
BigQueryDateShardedSpec

The bigqueryDateShardedSpec.

getBigqueryDateShardedSpecBuilder()

public BigQueryDateShardedSpec.Builder getBigqueryDateShardedSpecBuilder()

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;

Returns
Type Description
BigQueryDateShardedSpec.Builder

getBigqueryDateShardedSpecOrBuilder()

public BigQueryDateShardedSpecOrBuilder getBigqueryDateShardedSpecOrBuilder()

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;

Returns
Type Description
BigQueryDateShardedSpecOrBuilder

getBigqueryTableSpec()

public BigQueryTableSpec getBigqueryTableSpec()

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;

Returns
Type Description
BigQueryTableSpec

The bigqueryTableSpec.

getBigqueryTableSpecBuilder()

public BigQueryTableSpec.Builder getBigqueryTableSpecBuilder()

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;

Returns
Type Description
BigQueryTableSpec.Builder

getBigqueryTableSpecOrBuilder()

public BigQueryTableSpecOrBuilder getBigqueryTableSpecOrBuilder()

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;

Returns
Type Description
BigQueryTableSpecOrBuilder

getDefaultInstanceForType()

public Entry getDefaultInstanceForType()
Returns
Type Description
Entry

getDescription()

public String getDescription()

Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.

string description = 4;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.

string description = 4;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getEntryTypeCase()

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

getGcsFilesetSpec()

public GcsFilesetSpec getGcsFilesetSpec()

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

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

Returns
Type Description
GcsFilesetSpec

The gcsFilesetSpec.

getGcsFilesetSpecBuilder()

public GcsFilesetSpec.Builder getGcsFilesetSpecBuilder()

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

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

Returns
Type Description
GcsFilesetSpec.Builder

getGcsFilesetSpecOrBuilder()

public GcsFilesetSpecOrBuilder getGcsFilesetSpecOrBuilder()

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

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

Returns
Type Description
GcsFilesetSpecOrBuilder

getIntegratedSystem()

public IntegratedSystem getIntegratedSystem()

Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

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

Returns
Type Description
IntegratedSystem

The integratedSystem.

getIntegratedSystemValue()

public int getIntegratedSystemValue()

Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

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

Returns
Type Description
int

The enum numeric value on the wire for integratedSystem.

getLinkedResource()

public String getLinkedResource()

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

    Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.

string linked_resource = 9;

Returns
Type Description
String

The linkedResource.

getLinkedResourceBytes()

public ByteString getLinkedResourceBytes()

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

    Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.

string linked_resource = 9;

Returns
Type Description
ByteString

The bytes for linkedResource.

getName()

public String getName()

Output only. The Data Catalog resource name of the entry in URL format. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

    Note that this Entry and its child resources may not actually be stored in the location in this name.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The Data Catalog resource name of the entry in URL format. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

    Note that this Entry and its child resources may not actually be stored in the location in this name.

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

Returns
Type Description
ByteString

The bytes for name.

getSchema()

public Schema getSchema()

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

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

Returns
Type Description
Schema

The schema.

getSchemaBuilder()

public Schema.Builder getSchemaBuilder()

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

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

Returns
Type Description
Schema.Builder

getSchemaOrBuilder()

public SchemaOrBuilder getSchemaOrBuilder()

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

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

Returns
Type Description
SchemaOrBuilder

getSourceSystemTimestamps()

public SystemTimestamps getSourceSystemTimestamps()

Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SystemTimestamps

The sourceSystemTimestamps.

getSourceSystemTimestampsBuilder()

public SystemTimestamps.Builder getSourceSystemTimestampsBuilder()

Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SystemTimestamps.Builder

getSourceSystemTimestampsOrBuilder()

public SystemTimestampsOrBuilder getSourceSystemTimestampsOrBuilder()

Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SystemTimestampsOrBuilder

getSystemCase()

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

getType()

public EntryType getType()

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

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

Returns
Type Description
EntryType

The type.

getTypeSpecCase()

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

getTypeValue()

public int getTypeValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for type.

getUsageSignal()

public UsageSignal getUsageSignal()

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

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

Returns
Type Description
UsageSignal

The usageSignal.

getUsageSignalBuilder()

public UsageSignal.Builder getUsageSignalBuilder()

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

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

Returns
Type Description
UsageSignal.Builder

getUsageSignalOrBuilder()

public UsageSignalOrBuilder getUsageSignalOrBuilder()

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

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

Returns
Type Description
UsageSignalOrBuilder

getUserSpecifiedSystem()

public String getUserSpecifiedSystem()

This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Returns
Type Description
String

The userSpecifiedSystem.

getUserSpecifiedSystemBytes()

public ByteString getUserSpecifiedSystemBytes()

This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Returns
Type Description
ByteString

The bytes for userSpecifiedSystem.

getUserSpecifiedType()

public String getUserSpecifiedType()

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.

string user_specified_type = 16;

Returns
Type Description
String

The userSpecifiedType.

getUserSpecifiedTypeBytes()

public ByteString getUserSpecifiedTypeBytes()

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.

string user_specified_type = 16;

Returns
Type Description
ByteString

The bytes for userSpecifiedType.

hasBigqueryDateShardedSpec()

public boolean hasBigqueryDateShardedSpec()

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;

Returns
Type Description
boolean

Whether the bigqueryDateShardedSpec field is set.

hasBigqueryTableSpec()

public boolean hasBigqueryTableSpec()

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;

Returns
Type Description
boolean

Whether the bigqueryTableSpec field is set.

hasGcsFilesetSpec()

public boolean hasGcsFilesetSpec()

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

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

Returns
Type Description
boolean

Whether the gcsFilesetSpec field is set.

hasIntegratedSystem()

public boolean hasIntegratedSystem()

Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

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

Returns
Type Description
boolean

Whether the integratedSystem field is set.

hasSchema()

public boolean hasSchema()

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

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

Returns
Type Description
boolean

Whether the schema field is set.

hasSourceSystemTimestamps()

public boolean hasSourceSystemTimestamps()

Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sourceSystemTimestamps field is set.

hasType()

public boolean hasType()

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

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

Returns
Type Description
boolean

Whether the type field is set.

hasUsageSignal()

public boolean hasUsageSignal()

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

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

Returns
Type Description
boolean

Whether the usageSignal field is set.

hasUserSpecifiedSystem()

public boolean hasUserSpecifiedSystem()

This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Returns
Type Description
boolean

Whether the userSpecifiedSystem field is set.

hasUserSpecifiedType()

public boolean hasUserSpecifiedType()

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.

string user_specified_type = 16;

Returns
Type Description
boolean

Whether the userSpecifiedType field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBigqueryDateShardedSpec(BigQueryDateShardedSpec value)

public Entry.Builder mergeBigqueryDateShardedSpec(BigQueryDateShardedSpec value)

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;

Parameter
Name Description
value BigQueryDateShardedSpec
Returns
Type Description
Entry.Builder

mergeBigqueryTableSpec(BigQueryTableSpec value)

public Entry.Builder mergeBigqueryTableSpec(BigQueryTableSpec value)

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;

Parameter
Name Description
value BigQueryTableSpec
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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Entry.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Entry.Builder
Overrides

mergeGcsFilesetSpec(GcsFilesetSpec value)

public Entry.Builder mergeGcsFilesetSpec(GcsFilesetSpec value)

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

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

Parameter
Name Description
value GcsFilesetSpec
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.v1beta1.Schema schema = 5;

Parameter
Name Description
value Schema
Returns
Type Description
Entry.Builder

mergeSourceSystemTimestamps(SystemTimestamps value)

public Entry.Builder mergeSourceSystemTimestamps(SystemTimestamps value)

Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SystemTimestamps
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
Overrides

mergeUsageSignal(UsageSignal value)

public Entry.Builder mergeUsageSignal(UsageSignal value)

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

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

Parameter
Name Description
value UsageSignal
Returns
Type Description
Entry.Builder

setBigqueryDateShardedSpec(BigQueryDateShardedSpec value)

public Entry.Builder setBigqueryDateShardedSpec(BigQueryDateShardedSpec value)

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;

Parameter
Name Description
value BigQueryDateShardedSpec
Returns
Type Description
Entry.Builder

setBigqueryDateShardedSpec(BigQueryDateShardedSpec.Builder builderForValue)

public Entry.Builder setBigqueryDateShardedSpec(BigQueryDateShardedSpec.Builder builderForValue)

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

.google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;

Parameter
Name Description
builderForValue BigQueryDateShardedSpec.Builder
Returns
Type Description
Entry.Builder

setBigqueryTableSpec(BigQueryTableSpec value)

public Entry.Builder setBigqueryTableSpec(BigQueryTableSpec value)

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;

Parameter
Name Description
value BigQueryTableSpec
Returns
Type Description
Entry.Builder

setBigqueryTableSpec(BigQueryTableSpec.Builder builderForValue)

public Entry.Builder setBigqueryTableSpec(BigQueryTableSpec.Builder builderForValue)

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

.google.cloud.datacatalog.v1beta1.BigQueryTableSpec bigquery_table_spec = 12;

Parameter
Name Description
builderForValue BigQueryTableSpec.Builder
Returns
Type Description
Entry.Builder

setDescription(String value)

public Entry.Builder setDescription(String value)

Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.

string description = 4;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Entry.Builder setDescriptionBytes(ByteString value)

Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.

string description = 4;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setDisplayName(String value)

public Entry.Builder setDisplayName(String value)

Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.

string display_name = 3;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Entry.Builder setDisplayNameBytes(ByteString value)

Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.

string display_name = 3;

Parameter
Name Description
value ByteString

The 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
Overrides

setGcsFilesetSpec(GcsFilesetSpec value)

public Entry.Builder setGcsFilesetSpec(GcsFilesetSpec value)

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

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

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. This is only valid on entries of type FILESET.

.google.cloud.datacatalog.v1beta1.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. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

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

Parameter
Name Description
value IntegratedSystem

The integratedSystem to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setIntegratedSystemValue(int value)

public Entry.Builder setIntegratedSystemValue(int value)

Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

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

Parameter
Name Description
value int

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

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

    Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.

string linked_resource = 9;

Parameter
Name Description
value String

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

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId

    Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.

string linked_resource = 9;

Parameter
Name Description
value ByteString

The bytes for linkedResource to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setName(String value)

public Entry.Builder setName(String value)

Output only. The Data Catalog resource name of the entry in URL format. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

    Note that this Entry and its child resources may not actually be stored in the location in this name.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Entry.Builder setNameBytes(ByteString value)

Output only. The Data Catalog resource name of the entry in URL format. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

    Note that this Entry and its child resources may not actually be stored in the location in this name.

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

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
Overrides

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.v1beta1.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.v1beta1.Schema schema = 5;

Parameter
Name Description
builderForValue Schema.Builder
Returns
Type Description
Entry.Builder

setSourceSystemTimestamps(SystemTimestamps value)

public Entry.Builder setSourceSystemTimestamps(SystemTimestamps value)

Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SystemTimestamps
Returns
Type Description
Entry.Builder

setSourceSystemTimestamps(SystemTimestamps.Builder builderForValue)

public Entry.Builder setSourceSystemTimestamps(SystemTimestamps.Builder builderForValue)

Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1beta1.SystemTimestamps source_system_timestamps = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue SystemTimestamps.Builder
Returns
Type Description
Entry.Builder

setType(EntryType value)

public Entry.Builder setType(EntryType value)

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

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

Parameter
Name Description
value EntryType

The type to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setTypeValue(int value)

public Entry.Builder setTypeValue(int value)

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

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

Parameter
Name Description
value int

The 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
Overrides

setUsageSignal(UsageSignal value)

public Entry.Builder setUsageSignal(UsageSignal value)

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

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

Parameter
Name Description
value UsageSignal
Returns
Type Description
Entry.Builder

setUsageSignal(UsageSignal.Builder builderForValue)

public Entry.Builder setUsageSignal(UsageSignal.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue UsageSignal.Builder
Returns
Type Description
Entry.Builder

setUserSpecifiedSystem(String value)

public Entry.Builder setUserSpecifiedSystem(String value)

This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Parameter
Name Description
value String

The userSpecifiedSystem to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setUserSpecifiedSystemBytes(ByteString value)

public Entry.Builder setUserSpecifiedSystemBytes(ByteString value)

This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Parameter
Name Description
value ByteString

The bytes for userSpecifiedSystem to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setUserSpecifiedType(String value)

public Entry.Builder setUserSpecifiedType(String value)

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.

string user_specified_type = 16;

Parameter
Name Description
value String

The userSpecifiedType to set.
Returns
Type Description
Entry.Builder

This builder for chaining.

setUserSpecifiedTypeBytes(ByteString value)

public Entry.Builder setUserSpecifiedTypeBytes(ByteString value)

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.

string user_specified_type = 16;

Parameter
Name Description
value ByteString

The bytes for userSpecifiedType to set.
Returns
Type Description
Entry.Builder

This builder for chaining.