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.



6346
6347
6348
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6346

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:



6245
6246
6247
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6245

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) 


6252
6253
6254
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6252

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) 


6257
6258
6259
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6257

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:



6262
6263
6264
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6262

def compatibility
  @compatibility
end

#create_time ⇒ String

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

Returns:

  • (String) 


6267
6268
6269
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6267

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) 


6275
6276
6277
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6275

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) 


6281
6282
6283
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6281

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) 


6287
6288
6289
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6287

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) 


6292
6293
6294
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6292

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) 


6298
6299
6300
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6298

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:



6303
6304
6305
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6303

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) 


6311
6312
6313
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6311

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) 


6318
6319
6320
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6318

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:



6323
6324
6325
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6323

def schema
  @schema
end

#system ⇒ String

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

Returns:

  • (String) 


6328
6329
6330
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6328

def system
  @system
end

#type ⇒ String

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

Returns:

  • (String) 


6333
6334
6335
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6333

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) 


6339
6340
6341
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6339

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) 


6344
6345
6346
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6344

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 6351

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