Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1Entity

Returns a new instance of GoogleCloudDataplexV1Entity.



4504
4505
4506
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4504

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

Returns:



4403
4404
4405
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4403

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

Returns:

  • (String) 


4410
4411
4412
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4410

def asset
  @asset
end

#catalog_entry ⇒ String

Output only. The name of the associated Data Catalog entry. Corresponds to the JSON property catalogEntry

Returns:

  • (String) 


4415
4416
4417
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4415

def catalog_entry
  @catalog_entry
end

#compatibility ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1EntityCompatibilityStatus

Provides compatibility information for various metadata stores. Corresponds to the JSON property compatibility

Returns:



4420
4421
4422
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4420

def compatibility
  @compatibility
end

#create_time ⇒ String

Output only. The time when the entity was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4425
4426
4427
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4425

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

Returns:

  • (String) 


4433
4434
4435
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4433

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

Returns:

  • (String) 


4439
4440
4441
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4439

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

Returns:

  • (String) 


4445
4446
4447
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4445

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

Returns:

  • (String) 


4450
4451
4452
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4450

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

Returns:

  • (String) 


4456
4457
4458
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4456

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

Returns:



4461
4462
4463
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4461

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

Returns:

  • (String) 


4469
4470
4471
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4469

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

Returns:

  • (String) 


4476
4477
4478
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4476

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

Returns:



4481
4482
4483
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4481

def schema
  @schema
end

#system ⇒ String

Required. Immutable. Identifies the storage system of the entity data. Corresponds to the JSON property system

Returns:

  • (String) 


4486
4487
4488
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4486

def system
  @system
end

#type ⇒ String

Required. Immutable. The type of entity. Corresponds to the JSON property type

Returns:

  • (String) 


4491
4492
4493
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4491

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

Returns:

  • (String) 


4497
4498
4499
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4497

def uid
  @uid
end

#update_time ⇒ String

Output only. The time when the entity was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4502
4503
4504
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4502

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4509

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