Class: Google::Cloud::DataCatalog::V1beta1::Entry

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#bigquery_date_sharded_spec ⇒ ::Google::Cloud::DataCatalog::V1beta1::BigQueryDateShardedSpec

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

Note: The following fields are mutually exclusive: bigquery_date_sharded_spec, gcs_fileset_spec, bigquery_table_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#bigquery_table_spec ⇒ ::Google::Cloud::DataCatalog::V1beta1::BigQueryTableSpec

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

Note: The following fields are mutually exclusive: bigquery_table_spec, gcs_fileset_spec, bigquery_date_sharded_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DataCatalog::V1beta1::BigQueryTableSpec) —

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

    Note: The following fields are mutually exclusive: bigquery_table_spec, gcs_fileset_spec, bigquery_date_sharded_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

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

Returns:

  • (::String) —

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



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#gcs_fileset_spec ⇒ ::Google::Cloud::DataCatalog::V1beta1::GcsFilesetSpec

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

Note: The following fields are mutually exclusive: gcs_fileset_spec, bigquery_table_spec, bigquery_date_sharded_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DataCatalog::V1beta1::GcsFilesetSpec) —

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

    Note: The following fields are mutually exclusive: gcs_fileset_spec, bigquery_table_spec, bigquery_date_sharded_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#integrated_system ⇒ ::Google::Cloud::DataCatalog::V1beta1::IntegratedSystem (readonly)

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

Note: The following fields are mutually exclusive: integrated_system, user_specified_system. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DataCatalog::V1beta1::IntegratedSystem) —

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

    Note: The following fields are mutually exclusive: integrated_system, user_specified_system. If a field in that set is populated, all other fields in the set will automatically be cleared.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#linked_resource ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns 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.

Returns:

  • (::String) —

    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.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#schema ⇒ ::Google::Cloud::DataCatalog::V1beta1::Schema

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

Returns:



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#source_system_timestamps ⇒ ::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps (readonly)

Returns 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.

Returns:

  • (::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps) —

    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.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::Google::Cloud::DataCatalog::V1beta1::EntryType

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

Note: The following fields are mutually exclusive: type, user_specified_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DataCatalog::V1beta1::EntryType) —

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

    Note: The following fields are mutually exclusive: type, user_specified_type. If a field in that set is populated, all other fields in the set will automatically be cleared.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#usage_signal ⇒ ::Google::Cloud::DataCatalog::V1beta1::UsageSignal (readonly)

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

Returns:



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_specified_system ⇒ ::String

Returns 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.

Note: The following fields are mutually exclusive: user_specified_system, integrated_system. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    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.

    Note: The following fields are mutually exclusive: user_specified_system, integrated_system. If a field in that set is populated, all other fields in the set will automatically be cleared.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_specified_type ⇒ ::String

Returns 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.

Note: The following fields are mutually exclusive: user_specified_type, type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    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.

    Note: The following fields are mutually exclusive: user_specified_type, type. If a field in that set is populated, all other fields in the set will automatically be cleared.



483
484
485
486
 
# File 'proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb', line 483

class Entry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end