Creates a lake resource.

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-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.

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:

GoogleCloudDataplexV1Lake:
  asset-status:
    active-assets: integer
    security-policy-applying-assets: integer
    update-time: string
  create-time: string
  description: string
  display-name: string
  labels: { string: string }
  metastore:
    service: string
  metastore-status:
    endpoint: string
    message: string
    state: string
    update-time: string
  name: string
  service-account: string
  state: 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=64
    • Number of active assets.
  • security-policy-applying-assets=74
    • Number of assets that are in process of updating the security policy on attached resources.

  • update-time=sit

    • Last update time of the status.

  • .. create-time=vero

    • Output only. The time when the lake was created.
  • description=duo
    • Optional. Description of the lake.
  • display-name=sadipscing
    • Optional. User friendly display name.
  • labels=key=ut
    • Optional. User-defined labels for the lake.
    • the value will be associated with the given key

  • metastore service=rebum.

    • Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}

  • ..metastore-status endpoint=duo

    • The URI of the endpoint used to access the Metastore service.
  • message=kasd
    • Additional information about the current status.
  • state=sadipscing
    • Current state of association.

  • update-time=tempor

    • Last update time of the metastore status of the lake.

  • .. name=sea

    • Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
  • service-account=et
    • Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
  • state=lorem
    • Output only. Current state of the lake.
  • uid=magna
    • Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
  • update-time=takimata
    • Output only. The time when the lake 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 lake-id=string

    • Required. Lake 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 within the customer project / location.

  • -p validate-only=boolean

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

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