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 represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You 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, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag.

Defined Under Namespace

Classes: LabelsEntry

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 the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. Physical location of the entry.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_source_connection_spec ⇒ ::Google::Cloud::DataCatalog::V1::DataSourceConnectionSpec

Returns Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Specification that applies to a table resource. Valid only for entries with the TABLE type.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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}



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Cloud labels attached to the entry.

    In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#linked_resource ⇒ ::String

Returns The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the Full Resource Name. For example, the linked_resource for a table resource from BigQuery is:

//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Output only when the 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 Resource Name. For example, the linked_resource for a table resource from BigQuery is:

    //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

    Output only when the 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.



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

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

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.

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



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#routine_spec ⇒ ::Google::Cloud::DataCatalog::V1::RoutineSpec

Returns Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

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

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Timestamps from the underlying resource, not from the Data Catalog entry.

Output only when the entry has a type listed 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 from the underlying resource, not from the Data Catalog entry.

    Output only when the entry has a type listed in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

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

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

Returns:

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

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

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



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. Resource usage statistics.

Returns:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_specified_system ⇒ ::String

Returns Indicates the entry's source system that Data Catalog doesn't automatically integrate with.

The user_specified_system string has the following limitations:

  • Is case insensitive.
  • Must begin with a letter or underscore.
  • Can only contain letters, numbers, and underscores.
  • Must be at least 1 character and at most 64 characters long.

Returns:

  • (::String) —

    Indicates the entry's source system that Data Catalog doesn't automatically integrate with.

    The user_specified_system string has the following limitations:

    • Is case insensitive.
    • Must begin with a letter or underscore.
    • Can only contain letters, numbers, and underscores.
    • Must be at least 1 character and at most 64 characters long.


546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_specified_type ⇒ ::String

Returns Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum.

When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type.

The user_specified_type string has the following limitations:

  • Is case insensitive.
  • Must begin with a letter or underscore.
  • Can only contain letters, numbers, and underscores.
  • Must be at least 1 character and at most 64 characters long.

Returns:

  • (::String) —

    Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum.

    When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type.

    The user_specified_type string has the following limitations:

    • Is case insensitive.
    • Must begin with a letter or underscore.
    • Can only contain letters, numbers, and underscores.
    • Must be at least 1 character and at most 64 characters long.


546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 546

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end