Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity
- Inherits:
-
Object
- Object
- Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb
Overview
Represents tables and fileset metadata contained within a zone.
Instance Attribute Summary collapse
-
#access ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1StorageAccess
Describes the access mechanism of the data within its storage location.
-
#asset ⇒ String
Required.
-
#catalog_entry ⇒ String
Output only.
-
#compatibility ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1EntityCompatibilityStatus
Provides compatibility information for various metadata stores.
-
#create_time ⇒ String
Output only.
-
#data_path ⇒ String
Required.
-
#data_path_pattern ⇒ String
Optional.
-
#description ⇒ String
Optional.
-
#display_name ⇒ String
Optional.
-
#etag ⇒ String
Optional.
-
#format ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1StorageFormat
Describes the format of the data within its storage location.
-
#id ⇒ String
Required.
-
#name ⇒ String
Output only.
-
#schema ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1Schema
Schema information describing the structure and layout of the data.
-
#system ⇒ String
Required.
-
#type ⇒ String
Required.
-
#uid ⇒ String
Output only.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDataplexV1Entity
constructor
A new instance of GoogleCloudDataplexV1Entity.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDataplexV1Entity
Returns a new instance of GoogleCloudDataplexV1Entity.
3887 3888 3889 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3887 def initialize(**args) update!(**args) end |
Instance Attribute Details
#access ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1StorageAccess
Describes the access mechanism of the data within its storage location.
Corresponds to the JSON property access
3786 3787 3788 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3786 def access @access end |
#asset ⇒ 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.
Corresponds to the JSON property asset
3793 3794 3795 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3793 def asset @asset end |
#catalog_entry ⇒ String
Output only. The name of the associated Data Catalog entry.
Corresponds to the JSON property catalogEntry
3798 3799 3800 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3798 def catalog_entry @catalog_entry end |
#compatibility ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1EntityCompatibilityStatus
Provides compatibility information for various metadata stores.
Corresponds to the JSON property compatibility
3803 3804 3805 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3803 def compatibility @compatibility end |
#create_time ⇒ String
Output only. The time when the entity was created.
Corresponds to the JSON property createTime
3808 3809 3810 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3808 def create_time @create_time end |
#data_path ⇒ 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.
Corresponds to the JSON property dataPath
3816 3817 3818 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3816 def data_path @data_path end |
#data_path_pattern ⇒ 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.
Corresponds to the JSON property dataPathPattern
3822 3823 3824 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3822 def data_path_pattern @data_path_pattern end |
#description ⇒ String
Optional. User friendly longer description text. Must be shorter than or equal
to 1024 characters.
Corresponds to the JSON property description
3828 3829 3830 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3828 def description @description end |
#display_name ⇒ String
Optional. Display name must be shorter than or equal to 256 characters.
Corresponds to the JSON property displayName
3833 3834 3835 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3833 def display_name @display_name end |
#etag ⇒ String
Optional. The etag associated with the entity, which can be retrieved with a
GetEntity request. Required for update and delete requests.
Corresponds to the JSON property etag
3839 3840 3841 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3839 def etag @etag end |
#format ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1StorageFormat
Describes the format of the data within its storage location.
Corresponds to the JSON property format
3844 3845 3846 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3844 def format @format end |
#id ⇒ 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.
Corresponds to the JSON property id
3852 3853 3854 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3852 def id @id end |
#name ⇒ 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
.
Corresponds to the JSON property name
3859 3860 3861 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3859 def name @name end |
#schema ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1Schema
Schema information describing the structure and layout of the data.
Corresponds to the JSON property schema
3864 3865 3866 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3864 def schema @schema end |
#system ⇒ String
Required. Immutable. Identifies the storage system of the entity data.
Corresponds to the JSON property system
3869 3870 3871 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3869 def system @system end |
#type ⇒ String
Required. Immutable. The type of entity.
Corresponds to the JSON property type
3874 3875 3876 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3874 def type @type end |
#uid ⇒ 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.
Corresponds to the JSON property uid
3880 3881 3882 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3880 def uid @uid end |
#update_time ⇒ String
Output only. The time when the entity was last updated.
Corresponds to the JSON property updateTime
3885 3886 3887 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3885 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3892 def update!(**args) @access = args[:access] if args.key?(:access) @asset = args[:asset] if args.key?(:asset) @catalog_entry = args[:catalog_entry] if args.key?(:catalog_entry) @compatibility = args[:compatibility] if args.key?(:compatibility) @create_time = args[:create_time] if args.key?(:create_time) @data_path = args[:data_path] if args.key?(:data_path) @data_path_pattern = args[:data_path_pattern] if args.key?(:data_path_pattern) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @etag = args[:etag] if args.key?(:etag) @format = args[:format] if args.key?(:format) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @schema = args[:schema] if args.key?(:schema) @system = args[:system] if args.key?(:system) @type = args[:type] if args.key?(:type) @uid = args[:uid] if args.key?(:uid) @update_time = args[:update_time] if args.key?(:update_time) end |