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 \ V1Methods
__construct
Constructor.
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
↳ update_time
↳ 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" } } }
↳ access_approval_config
getName
Identifier. Resource name of the data product.
Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
.
string
setName
Identifier. Resource name of the data product.
Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
.
var
string
$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.
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.
var
string
$this
getDisplayName
Required. User-friendly display name of the data product.
string
setDisplayName
Required. User-friendly display name of the data product.
var
string
$this
getCreateTime
Output only. The time at which the data product was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the data product was created.
$this
getUpdateTime
Output only. The time at which the data product was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which the data product was last updated.
$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.
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.
var
string
$this
getLabels
Optional. User-defined labels for the data product.
Example:
{
"environment": "production",
"billing": "marketing-department"
}
setLabels
Optional. User-defined labels for the data product.
Example:
{
"environment": "production",
"billing": "marketing-department"
}
$this
getDescription
Optional. Description of the data product.
string
setDescription
Optional. Description of the data product.
var
string
$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.
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.
var
string
$this
getOwnerEmails
Required. Emails of the data product owners.
setOwnerEmails
Required. Emails of the data product owners.
var
string[]
$this
getAssetCount
Output only. Number of data assets associated with this data product.
int
setAssetCount
Output only. Number of data assets associated with this data product.
var
int
$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"
}
}
}
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"
}
}
}
$this
getAccessApprovalConfig
Optional. Configuration for access approval for the data product.
hasAccessApprovalConfig
clearAccessApprovalConfig
setAccessApprovalConfig
Optional. Configuration for access approval for the data product.
$this
