Class: Google::Cloud::Dataplex::V1::Entity

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

Overview

Represents tables and fileset metadata contained within a zone.

Defined Under Namespace

Modules: Type Classes: CompatibilityStatus

Instance Attribute Summary collapse

Instance Attribute Details

#access ⇒ ::Google::Cloud::Dataplex::V1::StorageAccess (readonly)

Returns Output only. Identifies the access mechanism to the entity. Not user settable.

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#asset ⇒ ::String

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#catalog_entry ⇒ ::String (readonly)

Returns Output only. The name of the associated Data Catalog entry.

Returns:

  • (::String) —

    Output only. The name of the associated Data Catalog entry.



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#compatibility ⇒ ::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus (readonly)

Returns Output only. Metadata stores that the entity is compatible with.

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the entity was created.

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#data_path ⇒ ::String

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#data_path_pattern ⇒ ::String

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#description ⇒ ::String

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#display_name ⇒ ::String

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#etag ⇒ ::String

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#format ⇒ ::Google::Cloud::Dataplex::V1::StorageFormat

Returns Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#id ⇒ ::String

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#name ⇒ ::String (readonly)

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

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

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

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#system ⇒ ::Google::Cloud::Dataplex::V1::StorageSystem

Returns Required. Immutable. Identifies the storage system of the entity data.

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#type ⇒ ::Google::Cloud::Dataplex::V1::Entity::Type

Returns Required. Immutable. The type of entity.

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#uid ⇒ ::String (readonly)

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

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.



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the entity was last updated.

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 338

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

  # Provides compatibility information for various metadata stores.
  # @!attribute [r] hive_metastore
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with Hive Metastore.
  # @!attribute [r] bigquery
  #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
  #     Output only. Whether this entity is compatible with BigQuery.
  class CompatibilityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Provides compatibility information for a specific metadata store.
    # @!attribute [r] compatible
    #   @return [::Boolean]
    #     Output only. Whether the entity is compatible and can be represented in
    #     the metadata store.
    # @!attribute [r] reason
    #   @return [::String]
    #     Output only. Provides additional detail if the entity is incompatible
    #     with the metadata store.
    class Compatibility
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The type of entity.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # Structured and semi-structured data.
    TABLE = 1

    # Unstructured data.
    FILESET = 2
  end
end