Interface EntryOrBuilder (1.40.0)

public interface EntryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBigqueryDateShardedSpec()

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

The bigqueryDateShardedSpec.

getBigqueryDateShardedSpecOrBuilder()

public abstract 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
TypeDescription
BigQueryDateShardedSpecOrBuilder

getBigqueryTableSpec()

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

The bigqueryTableSpec.

getBigqueryTableSpecOrBuilder()

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

getDescription()

public abstract 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
TypeDescription
String

The description.

getDescriptionBytes()

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

The bytes for description.

getDisplayName()

public abstract 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
TypeDescription
String

The displayName.

getDisplayNameBytes()

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

The bytes for displayName.

getEntryTypeCase()

public abstract Entry.EntryTypeCase getEntryTypeCase()
Returns
TypeDescription
Entry.EntryTypeCase

getGcsFilesetSpec()

public abstract 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
TypeDescription
GcsFilesetSpec

The gcsFilesetSpec.

getGcsFilesetSpecOrBuilder()

public abstract 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
TypeDescription
GcsFilesetSpecOrBuilder

getIntegratedSystem()

public abstract 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
TypeDescription
IntegratedSystem

The integratedSystem.

getIntegratedSystemValue()

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

The enum numeric value on the wire for integratedSystem.

getLinkedResource()

public abstract 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
TypeDescription
String

The linkedResource.

getLinkedResourceBytes()

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

The bytes for linkedResource.

getName()

public abstract 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
TypeDescription
String

The name.

getNameBytes()

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

The bytes for name.

getSchema()

public abstract Schema getSchema()

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

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

Returns
TypeDescription
Schema

The schema.

getSchemaOrBuilder()

public abstract SchemaOrBuilder getSchemaOrBuilder()

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

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

Returns
TypeDescription
SchemaOrBuilder

getSourceSystemTimestamps()

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

The sourceSystemTimestamps.

getSourceSystemTimestampsOrBuilder()

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

getSystemCase()

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

getType()

public abstract 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
TypeDescription
EntryType

The type.

getTypeSpecCase()

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

getTypeValue()

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

The enum numeric value on the wire for type.

getUsageSignal()

public abstract 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
TypeDescription
UsageSignal

The usageSignal.

getUsageSignalOrBuilder()

public abstract 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
TypeDescription
UsageSignalOrBuilder

getUserSpecifiedSystem()

public abstract 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
TypeDescription
String

The userSpecifiedSystem.

getUserSpecifiedSystemBytes()

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

The bytes for userSpecifiedSystem.

getUserSpecifiedType()

public abstract 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
TypeDescription
String

The userSpecifiedType.

getUserSpecifiedTypeBytes()

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

The bytes for userSpecifiedType.

hasBigqueryDateShardedSpec()

public abstract 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
TypeDescription
boolean

Whether the bigqueryDateShardedSpec field is set.

hasBigqueryTableSpec()

public abstract 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
TypeDescription
boolean

Whether the bigqueryTableSpec field is set.

hasGcsFilesetSpec()

public abstract 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
TypeDescription
boolean

Whether the gcsFilesetSpec field is set.

hasIntegratedSystem()

public abstract 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
TypeDescription
boolean

Whether the integratedSystem field is set.

hasSchema()

public abstract boolean hasSchema()

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

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

Returns
TypeDescription
boolean

Whether the schema field is set.

hasSourceSystemTimestamps()

public abstract 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
TypeDescription
boolean

Whether the sourceSystemTimestamps field is set.

hasType()

public abstract 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
TypeDescription
boolean

Whether the type field is set.

hasUsageSignal()

public abstract 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
TypeDescription
boolean

Whether the usageSignal field is set.

hasUserSpecifiedSystem()

public abstract 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
TypeDescription
boolean

Whether the userSpecifiedSystem field is set.

hasUserSpecifiedType()

public abstract 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
TypeDescription
boolean

Whether the userSpecifiedType field is set.