Cloud Dataplex v1 API - Class DataProduct (3.13.0)

public sealed class DataProduct : IMessage<DataProduct>, IEquatable<DataProduct>, IDeepCloneable<DataProduct>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API 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.

Inheritance

object > DataProduct

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataProduct()

public DataProduct()

DataProduct(DataProduct)

public DataProduct(DataProduct other)
Parameter
Name Description
other DataProduct

Properties

AccessGroups

public MapField<string, DataProduct.Types.AccessGroup> AccessGroups { get; }

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"
    }
  }
}
Property Value
Type Description
MapFieldstringDataProductTypesAccessGroup

AssetCount

public int AssetCount { get; set; }

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

Property Value
Type Description
int

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type Description
Timestamp

DataProductName

public DataProductName DataProductName { get; set; }

DataProductName-typed view over the Name resource name property.

Property Value
Type Description
DataProductName

Description

public string Description { get; set; }

Optional. Description of the data product.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

Etag

public string Etag { get; set; }

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.

Property Value
Type Description
string

Icon

public ByteString Icon { get; set; }

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.

Property Value
Type Description
ByteString

Labels

public MapField<string, string> Labels { get; }

Optional. User-defined labels for the data product.

Example:

{
  "environment": "production",
  "billing": "marketing-department"
}
Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

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

Property Value
Type Description
string

OwnerEmails

public RepeatedField<string> OwnerEmails { get; }

Required. Emails of the data product owners.

Property Value
Type Description
RepeatedFieldstring

Uid

public string Uid { get; set; }

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.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp