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.



3326
3327
3328
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3326

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:



3225
3226
3227
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3225

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) 


3232
3233
3234
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3232

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) 


3237
3238
3239
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3237

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:



3242
3243
3244
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3242

def compatibility
  @compatibility
end

#create_time ⇒ String

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

Returns:

  • (String) 


3247
3248
3249
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3247

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) 


3255
3256
3257
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3255

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) 


3261
3262
3263
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3261

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) 


3267
3268
3269
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3267

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) 


3272
3273
3274
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3272

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) 


3278
3279
3280
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3278

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:



3283
3284
3285
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3283

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) 


3291
3292
3293
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3291

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) 


3298
3299
3300
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3298

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:



3303
3304
3305
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3303

def schema
  @schema
end

#system ⇒ String

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

Returns:

  • (String) 


3308
3309
3310
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3308

def system
  @system
end

#type ⇒ String

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

Returns:

  • (String) 


3313
3314
3315
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3313

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) 


3319
3320
3321
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3319

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) 


3324
3325
3326
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3324

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3331

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