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
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: |
↳ 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}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| 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}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Optional. User friendly display name.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Optional. User friendly display name.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time when the zone was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the zone was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time when the zone was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the zone was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Optional. User defined labels for the zone.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Optional. User defined labels for the zone.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. Description of the zone.
Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. Description of the zone.
Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. Current state of the zone.
Generated from protobuf field .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. Current state of the zone.
Generated from protobuf field .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Required. Immutable. The type of the zone.
Generated from protobuf field .google.cloud.dataplex.v1.Zone.Type type = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Required. Immutable. The type of the zone.
Generated from protobuf field .google.cloud.dataplex.v1.Zone.Type type = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiscoverySpec
Optional. Specification of the discovery feature applied to data in this zone.
Generated from protobuf field .google.cloud.dataplex.v1.Zone.DiscoverySpec discovery_spec = 103 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field .google.cloud.dataplex.v1.Zone.DiscoverySpec discovery_spec = 103 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field .google.cloud.dataplex.v1.Zone.ResourceSpec resource_spec = 104 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field .google.cloud.dataplex.v1.Zone.ResourceSpec resource_spec = 104 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field .google.cloud.dataplex.v1.AssetStatus asset_status = 105 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\AssetStatus|null | |
hasAssetStatus
clearAssetStatus
setAssetStatus
Output only. Aggregated status of the underlying assets of the zone.
Generated from protobuf field .google.cloud.dataplex.v1.AssetStatus asset_status = 105 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\AssetStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |