Google Cloud Dataplex V1 Client - Class Zone (0.15.1)

Version 0.15.1

• 1.0.0 (latest)
• 1.0.0-RC1
• 0.16.1
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.3
• 0.1.6

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class 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.

Generated from protobuf message google.cloud.dataplex.v1.Zone

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ 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}.
↳ display_name	string Optional. User friendly display name.
↳ 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.
↳ create_time	Google\Protobuf\Timestamp Output only. The time when the zone was created.
↳ update_time	Google\Protobuf\Timestamp Output only. The time when the zone was last updated.
↳ labels	array|Google\Protobuf\Internal\MapField Optional. User defined labels for the zone.
↳ description	string Optional. Description of the zone.
↳ state	int Output only. Current state of the zone.
↳ type	int Required. Immutable. The type of the zone.
↳ discovery_spec	Google\Cloud\Dataplex\V1\Zone\DiscoverySpec Optional. Specification of the discovery feature applied to data in this zone.
↳ resource_spec	Google\Cloud\Dataplex\V1\Zone\ResourceSpec Required. Specification of the resources that are referenced by the assets within this zone.
↳ asset_status	Google\Cloud\Dataplex\V1\AssetStatus Output only. Aggregated status of the underlying assets of the zone.

getName

Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

Returns
Type	Description
string

setName

Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Optional. User friendly display name.

Returns
Type	Description
string

setDisplayName

Optional. User friendly display name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUid

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.

Returns
Type	Description
string

setUid

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. The time when the zone was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the zone was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The time when the zone was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the zone was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

Optional. User defined labels for the zone.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. User defined labels for the zone.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getDescription

Optional. Description of the zone.

Returns
Type	Description
string

setDescription

Optional. Description of the zone.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

Output only. Current state of the zone.

Returns
Type	Description
int

setState

Output only. Current state of the zone.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getType

Required. Immutable. The type of the zone.

Returns
Type	Description
int

setType

Required. Immutable. The type of the zone.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getDiscoverySpec

Optional. Specification of the discovery feature applied to data in this zone.

Returns
Type	Description
Google\Cloud\Dataplex\V1\Zone\DiscoverySpec|null

hasDiscoverySpec

clearDiscoverySpec

setDiscoverySpec

Optional. Specification of the discovery feature applied to data in this zone.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\Zone\DiscoverySpec

Returns
Type	Description
$this

getResourceSpec

Required. Specification of the resources that are referenced by the assets within this zone.

Returns
Type	Description
Google\Cloud\Dataplex\V1\Zone\ResourceSpec|null

hasResourceSpec

clearResourceSpec

setResourceSpec

Required. Specification of the resources that are referenced by the assets within this zone.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\Zone\ResourceSpec

Returns
Type	Description
$this

getAssetStatus

Output only. Aggregated status of the underlying assets of the zone.

Returns
Type	Description
Google\Cloud\Dataplex\V1\AssetStatus|null

hasAssetStatus

clearAssetStatus

setAssetStatus

Output only. Aggregated status of the underlying assets of the zone.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\AssetStatus

Returns
Type	Description
$this