zones

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

Overview

Name	zones
Type	Resource
Id	google.dataplex.zones

Fields

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}.
description	string	Optional. Description of the zone.
assetStatus	object	Aggregated status of the underlying assets of a lake or zone.
createTime	string	Output only. The time when the zone was created.
discoverySpec	object	Settings to manage the metadata discovery and publishing in a zone.
displayName	string	Optional. User friendly display name.
labels	object	Optional. User defined labels for the zone.
resourceSpec	object	Settings for resources attached as assets within a zone.
state	string	Output only. Current state of the zone.
type	string	Required. Immutable. The type of the zone.
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	Output only. The time when the zone was last updated.

Methods

Name	Accessible by	Required Params	Description
projects_locations_lakes_zones_get	SELECT	lakesId, locationsId, projectsId, zonesId	Retrieves a zone resource.
projects_locations_lakes_zones_list	SELECT	lakesId, locationsId, projectsId	Lists zone resources in a lake.
projects_locations_lakes_zones_create	INSERT	lakesId, locationsId, projectsId	Creates a zone resource within a lake.
projects_locations_lakes_zones_delete	DELETE	lakesId, locationsId, projectsId, zonesId	Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.
projects_locations_lakes_zones_patch	UPDATE	lakesId, locationsId, projectsId, zonesId	Updates a zone resource.

SELECT examples

Lists zone resources in a lake.

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

INSERT example

Use the following StackQL query and manifest file to create a new zones resource.

All Properties

/*+ create */
INSERT INTO google.dataplex.zones (
lakesId,
locationsId,
projectsId,
displayName,
labels,
description,
type,
discoverySpec,
resourceSpec
)
SELECT 
'{{ lakesId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ displayName }}',
'{{ labels }}',
'{{ description }}',
'{{ type }}',
'{{ discoverySpec }}',
'{{ resourceSpec }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: uid
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: description
      value: string
    - name: state
      value: string
    - name: type
      value: string
    - name: discoverySpec
      value:
        - name: enabled
          value: boolean
        - name: includePatterns
          value:
            - string
        - name: excludePatterns
          value:
            - string
        - name: csvOptions
          value:
            - name: headerRows
              value: integer
            - name: delimiter
              value: string
            - name: encoding
              value: string
            - name: disableTypeInference
              value: boolean
        - name: jsonOptions
          value:
            - name: encoding
              value: string
            - name: disableTypeInference
              value: boolean
        - name: schedule
          value: string
    - name: resourceSpec
      value:
        - name: locationType
          value: string
    - name: assetStatus
      value:
        - name: updateTime
          value: string
        - name: activeAssets
          value: integer
        - name: securityPolicyApplyingAssets
          value: integer

UPDATE example

Updates a zones resource.

/*+ update */
UPDATE google.dataplex.zones
SET 
displayName = '{{ displayName }}',
labels = '{{ labels }}',
description = '{{ description }}',
type = '{{ type }}',
discoverySpec = '{{ discoverySpec }}',
resourceSpec = '{{ resourceSpec }}'
WHERE 
lakesId = '{{ lakesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND zonesId = '{{ zonesId }}';

DELETE example

Deletes the specified zones resource.

/*+ delete */
DELETE FROM google.dataplex.zones
WHERE lakesId = '{{ lakesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND zonesId = '{{ zonesId }}';