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.



2361
2362
2363
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2361

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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) 


2272
2273
2274
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2272

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) 


2277
2278
2279
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2277

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:



2282
2283
2284
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2282

def compatibility
  @compatibility
end

#create_time ⇒ String

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

Returns:

  • (String) 


2287
2288
2289
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2287

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) 


2295
2296
2297
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2295

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) 


2301
2302
2303
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2301

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) 


2307
2308
2309
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2307

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) 


2312
2313
2314
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2312

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) 


2318
2319
2320
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2318

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:



2323
2324
2325
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2323

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. Must begin with a letter and consist of 256 or fewer characters. Corresponds to the JSON property id

Returns:

  • (String) 


2332
2333
2334
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2332

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) 


2339
2340
2341
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2339

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:



2344
2345
2346
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2344

def schema
  @schema
end

#system ⇒ String

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

Returns:

  • (String) 


2349
2350
2351
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2349

def system
  @system
end

#type ⇒ String

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

Returns:

  • (String) 


2354
2355
2356
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2354

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


2359
2360
2361
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2359

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2366

def update!(**args)
  @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)
  @update_time = args[:update_time] if args.key?(:update_time)
end