Google Cloud Dataplex V1 Client - Class DataProduct (1.12.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataProduct.

A data product is a curated collection of data assets, packaged to address specific use cases. It's a way to manage and share data in a more organized, product-like manner.

Generated from protobuf message google.cloud.dataplex.v1.DataProduct

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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

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.
↳ display_name string

Required. User-friendly display name of the data product.
↳ create_time Google\Protobuf\Timestamp

Output only. The time at which the data product was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time at which the data product was last updated.
↳ etag string

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.
↳ labels array|Google\Protobuf\Internal\MapField

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

Optional. Description of the data product.
↳ icon string

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.
↳ owner_emails string[]

Required. Emails of the data product owners.
↳ asset_count int

Output only. Number of data assets associated with this data product.
↳ access_groups array|Google\Protobuf\Internal\MapField

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" } } }

getName

Identifier. Resource name of the data product.

Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.

Returns
Type Description
string

setName

Identifier. Resource name of the data product.

Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

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.

Returns
Type Description
string

setUid

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

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

Returns
Type Description
string

setDisplayName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time at which the data product was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which the data product was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEtag

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.

Returns
Type Description
string

setEtag

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. User-defined labels for the data product.

Example:

{
  "environment": "production",
  "billing": "marketing-department"
}
Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined labels for the data product.

Example:

{
  "environment": "production",
  "billing": "marketing-department"
}
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDescription

Optional. Description of the data product.

Returns
Type Description
string

setDescription

Optional. Description of the data product.

Parameter
Name Description
var string
Returns
Type Description
$this

getIcon

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.

Returns
Type Description
string

setIcon

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getOwnerEmails

Required. Emails of the data product owners.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setOwnerEmails

Required. Emails of the data product owners.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getAssetCount

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

Returns
Type Description
int

setAssetCount

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

Parameter
Name Description
var int
Returns
Type Description
$this

getAccessGroups

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"
    }
  }
}
Returns
Type Description
Google\Protobuf\Internal\MapField

setAccessGroups

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"
    }
  }
}
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this