Create a metadata entity.

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

Required Scalar Argument

  • <parent> (string)
    • Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_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:

GoogleCloudDataplexV1Entity:
  access:
    read: string
  asset: string
  catalog-entry: string
  compatibility:
    bigquery:
      compatible: boolean
      reason: string
    hive-metastore:
      compatible: boolean
      reason: string
  create-time: string
  data-path: string
  data-path-pattern: string
  description: string
  display-name: string
  etag: string
  format:
    compression-format: string
    csv:
      delimiter: string
      encoding: string
      header-rows: integer
      quote: string
    format: string
    iceberg:
      metadata-location: string
    json:
      encoding: string
    mime-type: string
  id: string
  name: string
  schema:
    partition-style: string
    user-managed: boolean
  system: 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 .access read=vero

    • Output only. Describes the read access mechanism of the data. Not user settable.

  • .. asset=ea

    • Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
  • catalog-entry=magna
    • Output only. The name of the associated Data Catalog entry.
  • compatibility.bigquery compatible=true
    • Output only. Whether the entity is compatible and can be represented in the metadata store.

  • reason=amet

    • Output only. Provides additional detail if the entity is incompatible with the metadata store.

  • ..hive-metastore compatible=true

    • Output only. Whether the entity is compatible and can be represented in the metadata store.

  • reason=sadipscing

    • Output only. Provides additional detail if the entity is incompatible with the metadata store.

  • ... create-time=dolore

    • Output only. The time when the entity was created.
  • data-path=amet
    • Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
  • data-path-pattern=invidunt
    • Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/*/.csv.
  • description=invidunt
    • Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
  • display-name=dolores
    • Optional. Display name must be shorter than or equal to 256 characters.
  • etag=diam
    • Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
  • format compression-format=sanctus
    • Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
  • csv delimiter=sed
    • Optional. The delimiter used to separate values. Defaults to ','.
  • encoding=eos
    • Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
  • header-rows=48
    • Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.

  • quote=et

    • Optional. The character used to quote column values. Accepts '"' (double quotation mark) or ''' (single quotation mark). Defaults to '"' (double quotation mark) if unspecified.

  • .. format=ea

    • Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.

  • iceberg metadata-location=dolor

    • Optional. The location of where the iceberg metadata is present, must be within the table path

  • ..json encoding=sadipscing

    • Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified.

  • .. mime-type=diam

    • Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}

  • .. id=at

    • Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
  • name=at
    • Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
  • schema partition-style=kasd
    • Optional. The structure of paths containing partition data within the entity.

  • user-managed=true

    • Required. Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.

  • .. system=est

    • Required. Immutable. Identifies the storage system of the entity data.
  • type=gubergren
    • Required. Immutable. The type of entity.
  • uid=eos
    • Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
  • update-time=dolore
    • Output only. The time when the entity 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.

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