zones

Creates, updates, deletes, gets or lists a zones resource.

Overview

Name	zones
Type	Resource
Id	google.dataplex.zones

Fields

The following fields are returned by SELECT queries:

projects_locations_lakes_zones_get

Name	Datatype	Description
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}.
assetStatus	object	Output only. Aggregated status of the underlying assets of the zone. (id: GoogleCloudDataplexV1AssetStatus)
createTime	string (google-datetime)	Output only. The time when the zone was created.
description	string	Optional. Description of the zone.
discoverySpec	object	Optional. Specification of the discovery feature applied to data in this zone. (id: GoogleCloudDataplexV1ZoneDiscoverySpec)
displayName	string	Optional. User friendly display name.
labels	object	Optional. User defined labels for the zone.
resourceSpec	object	Required. Specification of the resources that are referenced by the assets within this zone. (id: GoogleCloudDataplexV1ZoneResourceSpec)
state	string	Output only. Current state of the zone. (STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED)
type	string	Required. Immutable. The type of the zone. (TYPE_UNSPECIFIED, RAW, CURATED)
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.
updateTime	string (google-datetime)	Output only. The time when the zone was last updated.

projects_locations_lakes_zones_list

Name	Datatype	Description
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}.
assetStatus	object	Output only. Aggregated status of the underlying assets of the zone. (id: GoogleCloudDataplexV1AssetStatus)
createTime	string (google-datetime)	Output only. The time when the zone was created.
description	string	Optional. Description of the zone.
discoverySpec	object	Optional. Specification of the discovery feature applied to data in this zone. (id: GoogleCloudDataplexV1ZoneDiscoverySpec)
displayName	string	Optional. User friendly display name.
labels	object	Optional. User defined labels for the zone.
resourceSpec	object	Required. Specification of the resources that are referenced by the assets within this zone. (id: GoogleCloudDataplexV1ZoneResourceSpec)
state	string	Output only. Current state of the zone. (STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED)
type	string	Required. Immutable. The type of the zone. (TYPE_UNSPECIFIED, RAW, CURATED)
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.
updateTime	string (google-datetime)	Output only. The time when the zone was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_lakes_zones_get	select	projectsId, locationsId, lakesId, zonesId		Retrieves a zone resource.
projects_locations_lakes_zones_list	select	projectsId, locationsId, lakesId	pageToken, filter, pageSize, orderBy	Lists zone resources in a lake.
projects_locations_lakes_zones_create	insert	projectsId, locationsId, lakesId	validateOnly, zoneId	Creates a zone resource within a lake.
projects_locations_lakes_zones_patch	update	projectsId, locationsId, lakesId, zonesId	updateMask, validateOnly	Updates a zone resource.
projects_locations_lakes_zones_delete	delete	projectsId, locationsId, lakesId, zonesId		Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
lakesId	string
locationsId	string
projectsId	string
zonesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean
zoneId	string

SELECT examples

projects_locations_lakes_zones_get

Retrieves a zone resource.

SELECT
name,
assetStatus,
createTime,
description,
discoverySpec,
displayName,
labels,
resourceSpec,
state,
type,
uid,
updateTime
FROM google.dataplex.zones
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND lakesId = '{{ lakesId }}' -- required
AND zonesId = '{{ zonesId }}' -- required
;

projects_locations_lakes_zones_list

Lists zone resources in a lake.

SELECT
name,
assetStatus,
createTime,
description,
discoverySpec,
displayName,
labels,
resourceSpec,
state,
type,
uid,
updateTime
FROM google.dataplex.zones
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND lakesId = '{{ lakesId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

projects_locations_lakes_zones_create

Creates a zone resource within a lake.

INSERT INTO google.dataplex.zones (
data__labels,
data__displayName,
data__discoverySpec,
data__type,
data__resourceSpec,
data__description,
projectsId,
locationsId,
lakesId,
validateOnly,
zoneId
)
SELECT 
'{{ labels }}',
'{{ displayName }}',
'{{ discoverySpec }}',
'{{ type }}',
'{{ resourceSpec }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ lakesId }}',
'{{ validateOnly }}',
'{{ zoneId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: zones
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the zones resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the zones resource.
  - name: lakesId
    value: "{{ lakesId }}"
    description: Required parameter for the zones resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User defined labels for the zone.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. User friendly display name.
  - name: discoverySpec
    description: |
      Optional. Specification of the discovery feature applied to data in this zone.
    value:
      excludePatterns:
        - "{{ excludePatterns }}"
      schedule: "{{ schedule }}"
      csvOptions:
        headerRows: {{ headerRows }}
        disableTypeInference: {{ disableTypeInference }}
        delimiter: "{{ delimiter }}"
        encoding: "{{ encoding }}"
      includePatterns:
        - "{{ includePatterns }}"
      enabled: {{ enabled }}
      jsonOptions:
        encoding: "{{ encoding }}"
        disableTypeInference: {{ disableTypeInference }}
  - name: type
    value: "{{ type }}"
    description: |
      Required. Immutable. The type of the zone.
    valid_values: ['TYPE_UNSPECIFIED', 'RAW', 'CURATED']
  - name: resourceSpec
    description: |
      Required. Specification of the resources that are referenced by the assets within this zone.
    value:
      locationType: "{{ locationType }}"
  - name: description
    value: "{{ description }}"
    description: |
      Optional. Description of the zone.
  - name: validateOnly
    value: {{ validateOnly }}
  - name: zoneId
    value: "{{ zoneId }}"

UPDATE examples

projects_locations_lakes_zones_patch

Updates a zone resource.

UPDATE google.dataplex.zones
SET 
data__labels = '{{ labels }}',
data__displayName = '{{ displayName }}',
data__discoverySpec = '{{ discoverySpec }}',
data__type = '{{ type }}',
data__resourceSpec = '{{ resourceSpec }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND lakesId = '{{ lakesId }}' --required
AND zonesId = '{{ zonesId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_lakes_zones_delete

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

DELETE FROM google.dataplex.zones
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND lakesId = '{{ lakesId }}' --required
AND zonesId = '{{ zonesId }}' --required
;