projects

Changed on

Creates a data product.

post/v1/{+parent}/dataProducts

Request

  • Base URL: https://dataplex.googleapis.com
  • URL: https://dataplex.googleapis.com/v1/{+parent}/dataProducts
  • 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 parent resource where this data product will be created. Format: projects/{project_id_or_number}/locations/{location_id}

Query parameters

dataProductIdstring

Optional. The ID of the data product to create.The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: ^a-z?$ If not provided, a system generated ID will be used.

validateOnlyboolean

Optional. Validates the request without actually creating the data product. Default: false.

Request body

accessGroupsobject

Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" } } }

assetCountinteger

Output only. Number of data assets associated with this data product.

createTimestring google-datetime

Output only. The time at which the data product was created.

descriptionstring

Optional. Description of the data product.

displayNamestring

Required. User-friendly display name of the data product.

etagstring

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

iconstring byte

Optional. Base64 encoded image representing the data product. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.

labelsobject

Optional. User-defined labels for the data product.Example: { "environment": "production", "billing": "marketing-department" }

namestring

Identifier. Resource name of the data product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.

ownerEmailsstring[]

Required. Emails of the data product owners.

uidstring

Output only. System generated unique ID for the data product. This ID will be different if the data product is deleted and re-created with the same name.

updateTimestring google-datetime

Output only. The time at which the data product 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