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.



5741
5742
5743
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5741

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:



5682
5683
5684
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5682

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) 


5687
5688
5689
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5687

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


5692
5693
5694
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5692

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:



5697
5698
5699
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5697

def discovery_spec
  @discovery_spec
end

#display_name ⇒ String

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

Returns:

  • (String) 


5702
5703
5704
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5702

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


5707
5708
5709
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5707

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) 


5713
5714
5715
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5713

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:



5718
5719
5720
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5718

def resource_spec
  @resource_spec
end

#state ⇒ String

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

Returns:

  • (String) 


5723
5724
5725
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5723

def state
  @state
end

#type ⇒ String

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

Returns:

  • (String) 


5728
5729
5730
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5728

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) 


5734
5735
5736
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5734

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) 


5739
5740
5741
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5739

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5746

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