Package com.google.cloud.datacatalog.v1beta1

Interface EntryOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Entry, Entry.Builder
@Generated public interface EntryOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. Identifier. 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.field_behavior) = IDENTIFIER, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. 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.field_behavior) = IDENTIFIER, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getLinkedResource

      String getLinkedResource()
       The resource this metadata entry refers to.

 For Google Cloud Platform resources, `linked_resource` is the [full name of
 the
 resource](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/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:
      The linkedResource.

    • getLinkedResourceBytes

      com.google.protobuf.ByteString getLinkedResourceBytes()
       The resource this metadata entry refers to.

 For Google Cloud Platform resources, `linked_resource` is the [full name of
 the
 resource](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/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:
      The bytes for linkedResource.

    • hasType

      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:
      Whether the type field is set.

    • getTypeValue

      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:
      The enum numeric value on the wire for type.

    • getType

      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:
      The type.

    • hasUserSpecifiedType

      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:
      Whether the userSpecifiedType field is set.

    • getUserSpecifiedType

      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:
      The userSpecifiedType.

    • getUserSpecifiedTypeBytes

      com.google.protobuf.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:
      The bytes for userSpecifiedType.

    • hasIntegratedSystem

      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:
      Whether the integratedSystem field is set.

    • getIntegratedSystemValue

      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:
      The enum numeric value on the wire for integratedSystem.

    • getIntegratedSystem

      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:
      The integratedSystem.

    • hasUserSpecifiedSystem

      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:
      Whether the userSpecifiedSystem field is set.

    • getUserSpecifiedSystem

      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:
      The userSpecifiedSystem.

    • getUserSpecifiedSystemBytes

      com.google.protobuf.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:
      The bytes for userSpecifiedSystem.

    • hasGcsFilesetSpec

      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:
      Whether the gcsFilesetSpec field is set.

    • getGcsFilesetSpec

      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:
      The gcsFilesetSpec.

    • getGcsFilesetSpecOrBuilder

      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;

    • hasBigqueryTableSpec

      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:
      Whether the bigqueryTableSpec field is set.

    • getBigqueryTableSpec

      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:
      The bigqueryTableSpec.

    • getBigqueryTableSpecOrBuilder

      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;

    • hasBigqueryDateShardedSpec

      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:
      Whether the bigqueryDateShardedSpec field is set.

    • getBigqueryDateShardedSpec

      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:
      The bigqueryDateShardedSpec.

    • getBigqueryDateShardedSpecOrBuilder

      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;

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.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:
      The bytes for displayName.

    • getDescription

      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:
      The description.

    • getDescriptionBytes

      com.google.protobuf.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:
      The bytes for description.

    • hasSchema

      boolean hasSchema()
       Schema of the entry. An entry might not have any schema attached to it.
      .google.cloud.datacatalog.v1beta1.Schema schema = 5;
      Returns:
      Whether the schema field is set.

    • getSchema

      Schema getSchema()
       Schema of the entry. An entry might not have any schema attached to it.
      .google.cloud.datacatalog.v1beta1.Schema schema = 5;
      Returns:
      The schema.

    • getSchemaOrBuilder

      SchemaOrBuilder getSchemaOrBuilder()
       Schema of the entry. An entry might not have any schema attached to it.
      .google.cloud.datacatalog.v1beta1.Schema schema = 5;

    • hasSourceSystemTimestamps

      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:
      Whether the sourceSystemTimestamps field is set.

    • getSourceSystemTimestamps

      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:
      The sourceSystemTimestamps.

    • getSourceSystemTimestampsOrBuilder

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

    • hasUsageSignal

      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:
      Whether the usageSignal field is set.

    • getUsageSignal

      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:
      The usageSignal.

    • getUsageSignalOrBuilder

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

    • getEntryTypeCase

      Entry.EntryTypeCase getEntryTypeCase()

    • getSystemCase

      Entry.SystemCase getSystemCase()

    • getTypeSpecCase

      Entry.TypeSpecCase getTypeSpecCase()