Creates a zone resource within a lake.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: dataplex1 --scope <scope> projects locations-lakes-zones-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudDataplexV1Zone:
  asset-status:
    active-assets: integer
    security-policy-applying-assets: integer
    update-time: string
  create-time: string
  description: string
  discovery-spec:
    csv-options:
      delimiter: string
      disable-type-inference: boolean
      encoding: string
      header-rows: integer
    enabled: boolean
    exclude-patterns: [string]
    include-patterns: [string]
    json-options:
      disable-type-inference: boolean
      encoding: string
    schedule: string
  display-name: string
  labels: { string: string }
  name: string
  resource-spec:
    location-type: string
  state: string
  type: string
  uid: string
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .asset-status active-assets=89
    • Number of active assets.
  • security-policy-applying-assets=67
    • Number of assets that are in process of updating the security policy on attached resources.

  • update-time=ea

    • Last update time of the status.

  • .. create-time=elitr

    • Output only. The time when the zone was created.
  • description=takimata
    • Optional. Description of the zone.
  • discovery-spec.csv-options delimiter=duo
    • Optional. The delimiter being used to separate values. This defaults to ','.
  • disable-type-inference=false
    • Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
  • encoding=clita
    • Optional. The character encoding of the data. The default is UTF-8.

  • header-rows=71

    • Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.

  • .. enabled=true

    • Required. Whether discovery is enabled.
  • exclude-patterns=stet
    • Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
    • Each invocation of this argument appends the given value to the array.
  • include-patterns=sea
    • Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
    • Each invocation of this argument appends the given value to the array.
  • json-options disable-type-inference=true
    • Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).

  • encoding=consetetur

    • Optional. The character encoding of the data. The default is UTF-8.

  • .. schedule=dolores

    • Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * , or TZ=America/New_York 1 * * .

  • .. display-name=sit

    • Optional. User friendly display name.
  • labels=key=sea
    • Optional. User defined labels for the zone.
    • the value will be associated with the given key
  • name=sanctus
    • Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

  • resource-spec location-type=kasd

    • Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.

  • .. state=eirmod

    • Output only. Current state of the zone.
  • type=dolores
    • Required. Immutable. The type of the zone.
  • uid=aliquyam
    • 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.
  • update-time=dolor
    • Output only. The time when the zone was last updated.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p validate-only=boolean

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

  • -p zone-id=string

    • 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")

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").