Class: Google::Cloud::DataCatalog::V1::Entry

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1/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::V1::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.

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

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

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

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

#data_source ⇒ ::Google::Cloud::DataCatalog::V1::DataSource (readonly)

Returns Output only. Physical location of the entry.

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

#database_table_spec ⇒ ::Google::Cloud::DataCatalog::V1::DatabaseTableSpec

Returns Specification that applies to a table resource. Only valid for entries of TABLE type.

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

#description ⇒ ::String

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

Returns:

  • (::String) —

    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.



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

#display_name ⇒ ::String

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

Returns:

  • (::String) —

    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.



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

#fully_qualified_name ⇒ ::String

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

Returns:

  • (::String) —

    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



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

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

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

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

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

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

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

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



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

#name ⇒ ::String (readonly)

Returns Output only. The resource name of an entry in URL format. Example:

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

Note: The entry itself and its child resources might not be stored in the location specified in its name.

Returns:

  • (::String) —

    Output only. The resource name of an entry in URL format. Example:

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

    Note: The entry itself and its child resources might not be stored in the location specified in its name.



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

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

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

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

#source_system_timestamps ⇒ ::Google::Cloud::DataCatalog::V1::SystemTimestamps

Returns 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::V1::SystemTimestamps) —

    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.



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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

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

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

Returns:



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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.

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.



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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.

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.



499
500
501
502
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 499

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