projects

Changed on

Creates a zone resource within a lake.

post/v1/{+parent}/zones

Request

  • Base URL: https://dataplex.googleapis.com
  • URL: https://dataplex.googleapis.com/v1/{+parent}/zones
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/dataplex.read-write) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/dataplex.read-write)

Path parameters

parentstring required

Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.

Query parameters

validateOnlyboolean

Optional. Only validate the request, but do not perform mutations. The default is false.

zoneIdstring

Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique across all lakes from all locations in a project. * Must not be one of the reserved IDs (i.e. "default", "global-temp")

Request body

createTimestring google-datetime

Output only. The time when the zone was created.

descriptionstring

Optional. Description of the zone.

displayNamestring

Optional. User friendly display name.

labelsobject

Optional. User defined labels for the zone.

namestring

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

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'CREATING' | 'DELETING' | 'ACTION_REQUIRED'

Output only. Current state of the zone.

type'TYPE_UNSPECIFIED' | 'RAW' | 'CURATED'

Required. Immutable. The type of the zone.

uidstring

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.

updateTimestring google-datetime

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

Response

Successful response

Changes

  • 6c7e9028cba8Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2c

  • 395bfc8abfeeRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2c