Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Entity (v1.1.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Entity.

Represents tables and fileset metadata contained within a zone.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#access

def access() -> ::Google::Cloud::Dataplex::V1::StorageAccess
Returns

#asset

def asset() -> ::String
Returns
  • (::String) — Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

#asset=

def asset=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
Returns
  • (::String) — Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

#catalog_entry

def catalog_entry() -> ::String
Returns
  • (::String) — Output only. The name of the associated Data Catalog entry.

#compatibility

def compatibility() -> ::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_path

def data_path() -> ::String
Returns
  • (::String) — Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

#data_path=

def data_path=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
Returns
  • (::String) — Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

#data_path_pattern

def data_path_pattern() -> ::String
Returns
  • (::String) — Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

#data_path_pattern=

def data_path_pattern=(value) -> ::String
Parameter
  • value (::String) — Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
Returns
  • (::String) — Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

#description

def description() -> ::String
Returns
  • (::String) — Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
Returns
  • (::String) — Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. Display name must be shorter than or equal to 256 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. Display name must be shorter than or equal to 256 characters.
Returns
  • (::String) — Optional. Display name must be shorter than or equal to 256 characters.

#etag

def etag() -> ::String
Returns
  • (::String) — Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.
Returns
  • (::String) — Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.

#format

def format() -> ::Google::Cloud::Dataplex::V1::StorageFormat
Returns

#format=

def format=(value) -> ::Google::Cloud::Dataplex::V1::StorageFormat
Parameter
Returns

#id

def id() -> ::String
Returns
  • (::String) — Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
Returns
  • (::String) — Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.

#schema

def schema() -> ::Google::Cloud::Dataplex::V1::Schema
Returns
  • (::Google::Cloud::Dataplex::V1::Schema) — Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

#schema=

def schema=(value) -> ::Google::Cloud::Dataplex::V1::Schema
Parameter
  • value (::Google::Cloud::Dataplex::V1::Schema) — Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
Returns
  • (::Google::Cloud::Dataplex::V1::Schema) — Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

#system

def system() -> ::Google::Cloud::Dataplex::V1::StorageSystem
Returns

#system=

def system=(value) -> ::Google::Cloud::Dataplex::V1::StorageSystem
Parameter
Returns

#type

def type() -> ::Google::Cloud::Dataplex::V1::Entity::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Dataplex::V1::Entity::Type
Parameter
Returns

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns