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.



3141
3142
3143
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3141

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:



3082
3083
3084
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3082

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) 


3087
3088
3089
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3087

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


3092
3093
3094
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3092

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:



3097
3098
3099
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3097

def discovery_spec
  @discovery_spec
end

#display_name ⇒ String

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

Returns:

  • (String) 


3102
3103
3104
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3102

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


3107
3108
3109
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3107

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) 


3113
3114
3115
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3113

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:



3118
3119
3120
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3118

def resource_spec
  @resource_spec
end

#state ⇒ String

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

Returns:

  • (String) 


3123
3124
3125
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3123

def state
  @state
end

#type ⇒ String

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

Returns:

  • (String) 


3128
3129
3130
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3128

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) 


3134
3135
3136
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3134

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) 


3139
3140
3141
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3139

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3146

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