Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone

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

A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1Zone

Returns a new instance of GoogleCloudDataplexV1Zone.



5653
5654
5655
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5653

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

Instance Attribute Details

#asset_status ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1AssetStatus

Aggregated status of the underlying assets of a lake or zone. Corresponds to the JSON property assetStatus

Returns:



5594
5595
5596
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5594

def asset_status
  @asset_status
end

#create_time ⇒ String

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

Returns:

  • (String) 


5599
5600
5601
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5599

def create_time
  @create_time
end

#description ⇒ String

Optional. Description of the zone. Corresponds to the JSON property description

Returns:

  • (String) 


5604
5605
5606
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5604

def description
  @description
end

#discovery_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1ZoneDiscoverySpec

Settings to manage the metadata discovery and publishing in a zone. Corresponds to the JSON property discoverySpec

Returns:



5609
5610
5611
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5609

def discovery_spec
  @discovery_spec
end

#display_name ⇒ String

Optional. User friendly display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


5614
5615
5616
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5614

def display_name
  @display_name
end

#labels ⇒ Hash<String,String>

Optional. User defined labels for the zone. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


5619
5620
5621
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5619

def labels
  @labels
end

#name ⇒ String

Output only. The relative resource name of the zone, of the form: projects/ project_number/locations/location_id/lakes/lake_id/zones/zone_id. Corresponds to the JSON property name

Returns:

  • (String) 


5625
5626
5627
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5625

def name
  @name
end

#resource_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1ZoneResourceSpec

Settings for resources attached as assets within a zone. Corresponds to the JSON property resourceSpec

Returns:



5630
5631
5632
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5630

def resource_spec
  @resource_spec
end

#state ⇒ String

Output only. Current state of the zone. Corresponds to the JSON property state

Returns:

  • (String) 


5635
5636
5637
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5635

def state
  @state
end

#type ⇒ String

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

Returns:

  • (String) 


5640
5641
5642
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5640

def type
  @type
end

#uid ⇒ String

Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name. Corresponds to the JSON property uid

Returns:

  • (String) 


5646
5647
5648
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5646

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


5651
5652
5653
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5651

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5658

def update!(**args)
  @asset_status = args[:asset_status] if args.key?(:asset_status)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @discovery_spec = args[:discovery_spec] if args.key?(:discovery_spec)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @resource_spec = args[:resource_spec] if args.key?(:resource_spec)
  @state = args[:state] if args.key?(:state)
  @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