Google Cloud Data Catalog V1BETA1 API - Class Google::Cloud::DataCatalog::V1beta1::Entry (v0.3.2)

Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::Entry.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#bigquery_date_sharded_spec

def bigquery_date_sharded_spec() -> ::Google::Cloud::DataCatalog::V1beta1::BigQueryDateShardedSpec

Returns

(::Google::Cloud::DataCatalog::V1beta1::BigQueryDateShardedSpec) — Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

#bigquery_date_sharded_spec=

def bigquery_date_sharded_spec=(value) -> ::Google::Cloud::DataCatalog::V1beta1::BigQueryDateShardedSpec

Parameter

value (::Google::Cloud::DataCatalog::V1beta1::BigQueryDateShardedSpec) — 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

(::Google::Cloud::DataCatalog::V1beta1::BigQueryDateShardedSpec) — Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

#bigquery_table_spec

def bigquery_table_spec() -> ::Google::Cloud::DataCatalog::V1beta1::BigQueryTableSpec

Returns

(::Google::Cloud::DataCatalog::V1beta1::BigQueryTableSpec) — Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

#bigquery_table_spec=

def bigquery_table_spec=(value) -> ::Google::Cloud::DataCatalog::V1beta1::BigQueryTableSpec

Parameter

value (::Google::Cloud::DataCatalog::V1beta1::BigQueryTableSpec) — Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

Returns

(::Google::Cloud::DataCatalog::V1beta1::BigQueryTableSpec) — Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

#description

def description() -> ::String

Returns

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

#description=

def description=(value) -> ::String

Parameter

value (::String) — 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.

#display_name

def display_name() -> ::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.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::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.

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.

#gcs_fileset_spec

def gcs_fileset_spec() -> ::Google::Cloud::DataCatalog::V1beta1::GcsFilesetSpec

Returns

(::Google::Cloud::DataCatalog::V1beta1::GcsFilesetSpec) — Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

#gcs_fileset_spec=

def gcs_fileset_spec=(value) -> ::Google::Cloud::DataCatalog::V1beta1::GcsFilesetSpec

Parameter

value (::Google::Cloud::DataCatalog::V1beta1::GcsFilesetSpec) — Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

Returns

(::Google::Cloud::DataCatalog::V1beta1::GcsFilesetSpec) — Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

#integrated_system

def integrated_system() -> ::Google::Cloud::DataCatalog::V1beta1::IntegratedSystem

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.

#linked_resource

def linked_resource() -> ::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.

#linked_resource=

def linked_resource=(value) -> ::String

Parameter

value (::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.

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.

#name

def name() -> ::String

Returns

(::String) — 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.

#schema

def schema() -> ::Google::Cloud::DataCatalog::V1beta1::Schema

Returns

(::Google::Cloud::DataCatalog::V1beta1::Schema) — Schema of the entry. An entry might not have any schema attached to it.

#schema=

def schema=(value) -> ::Google::Cloud::DataCatalog::V1beta1::Schema

Parameter

value (::Google::Cloud::DataCatalog::V1beta1::Schema) — Schema of the entry. An entry might not have any schema attached to it.

Returns

(::Google::Cloud::DataCatalog::V1beta1::Schema) — Schema of the entry. An entry might not have any schema attached to it.

#source_system_timestamps

def source_system_timestamps() -> ::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps

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.

#type

def type() -> ::Google::Cloud::DataCatalog::V1beta1::EntryType

Returns

(::Google::Cloud::DataCatalog::V1beta1::EntryType) — The type of the entry. Only used for Entries with types in the EntryType enum.

#type=

def type=(value) -> ::Google::Cloud::DataCatalog::V1beta1::EntryType

Parameter

value (::Google::Cloud::DataCatalog::V1beta1::EntryType) — The type of the entry. Only used for Entries with types in the EntryType enum.

Returns

(::Google::Cloud::DataCatalog::V1beta1::EntryType) — The type of the entry. Only used for Entries with types in the EntryType enum.

#usage_signal

def usage_signal() -> ::Google::Cloud::DataCatalog::V1beta1::UsageSignal

Returns

(::Google::Cloud::DataCatalog::V1beta1::UsageSignal) — Output only. Statistics on the usage level of the resource.

#user_specified_system

def user_specified_system() -> ::String

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.

#user_specified_system=

def user_specified_system=(value) -> ::String

Parameter

value (::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.

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.

#user_specified_type

def user_specified_type() -> ::String

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.

#user_specified_type=

def user_specified_type=(value) -> ::String

Parameter

value (::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.

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.