Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Zone.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#asset_status
def asset_status() -> ::Google::Cloud::Dataplex::V1::AssetStatus
    Returns
    
  - (::Google::Cloud::Dataplex::V1::AssetStatus) — Output only. Aggregated status of the underlying assets of the zone.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
    Returns
    
  - (::Google::Protobuf::Timestamp) — Output only. The time when the zone was created.
#description
def description() -> ::String
    Returns
    
  - (::String) — Optional. Description of the zone.
#description=
def description=(value) -> ::String
    Parameter
    
  - value (::String) — Optional. Description of the zone.
    Returns
    
  - (::String) — Optional. Description of the zone.
#discovery_spec
def discovery_spec() -> ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec
    Returns
    
  - (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec) — Optional. Specification of the discovery feature applied to data in this zone.
#discovery_spec=
def discovery_spec=(value) -> ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec
    Parameter
    
  - value (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec) — Optional. Specification of the discovery feature applied to data in this zone.
    Returns
    
  - (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec) — Optional. Specification of the discovery feature applied to data in this zone.
#display_name
def display_name() -> ::String
    Returns
    
  - (::String) — Optional. User friendly display name.
#display_name=
def display_name=(value) -> ::String
    Parameter
    
  - value (::String) — Optional. User friendly display name.
    Returns
    
  - (::String) — Optional. User friendly display name.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
    Returns
    
  - (::Google::Protobuf::Map{::String => ::String}) — Optional. User defined labels for the zone.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
    Parameter
    
  - value (::Google::Protobuf::Map{::String => ::String}) — Optional. User defined labels for the zone.
    Returns
    
  - (::Google::Protobuf::Map{::String => ::String}) — Optional. User defined labels for the zone.
#name
def name() -> ::String
    Returns
    
  - 
        (::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}.
#resource_spec
def resource_spec() -> ::Google::Cloud::Dataplex::V1::Zone::ResourceSpec
    Returns
    
  - (::Google::Cloud::Dataplex::V1::Zone::ResourceSpec) — Required. Specification of the resources that are referenced by the assets within this zone.
#resource_spec=
def resource_spec=(value) -> ::Google::Cloud::Dataplex::V1::Zone::ResourceSpec
    Parameter
    
  - value (::Google::Cloud::Dataplex::V1::Zone::ResourceSpec) — Required. Specification of the resources that are referenced by the assets within this zone.
    Returns
    
  - (::Google::Cloud::Dataplex::V1::Zone::ResourceSpec) — Required. Specification of the resources that are referenced by the assets within this zone.
#state
def state() -> ::Google::Cloud::Dataplex::V1::State
    Returns
    
  - (::Google::Cloud::Dataplex::V1::State) — Output only. Current state of the zone.
#type
def type() -> ::Google::Cloud::Dataplex::V1::Zone::Type
    Returns
    
  - (::Google::Cloud::Dataplex::V1::Zone::Type) — Required. Immutable. The type of the zone.
#type=
def type=(value) -> ::Google::Cloud::Dataplex::V1::Zone::Type
    Parameter
    
  - value (::Google::Cloud::Dataplex::V1::Zone::Type) — Required. Immutable. The type of the zone.
    Returns
    
  - (::Google::Cloud::Dataplex::V1::Zone::Type) — Required. Immutable. The type of the zone.
#uid
def uid() -> ::String
    Returns
    
  - (::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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
    Returns
    
- (::Google::Protobuf::Timestamp) — Output only. The time when the zone was last updated.