Interface DataProductOrBuilder (1.86.0)

1.86.0 (latest) 1.85.0 1.83.0 1.81.0 1.80.0 1.79.0 1.78.0 1.76.0 1.74.0 1.73.0 1.72.0 1.71.0 1.70.0 1.68.0 1.66.0 1.65.0 1.62.0 1.61.0 1.60.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.2 1.0.1 0.2.2

public interface DataProductOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAccessGroups(String key)

public abstract boolean containsAccessGroups(String key)

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: <code><code> { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts&#64;example.com" } } } </code></code>

map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. User-defined labels for the data product.

Example: <code><code> { "environment": "production", "billing": "marketing-department" } </code></code>

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAccessGroups() (deprecated)

public abstract Map<String,DataProduct.AccessGroup> getAccessGroups()

Use #getAccessGroupsMap() instead.

Returns
Type	Description
Map<String,AccessGroup>

getAccessGroupsCount()

public abstract int getAccessGroupsCount()

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: <code><code> { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts&#64;example.com" } } } </code></code>

map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAccessGroupsMap()

public abstract Map<String,DataProduct.AccessGroup> getAccessGroupsMap()

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: <code><code> { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts&#64;example.com" } } } </code></code>

map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,AccessGroup>

getAccessGroupsOrDefault(String key, DataProduct.AccessGroup defaultValue)

public abstract DataProduct.AccessGroup getAccessGroupsOrDefault(String key, DataProduct.AccessGroup defaultValue)

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: <code><code> { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts&#64;example.com" } } } </code></code>

map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	DataProduct.AccessGroup

Returns
Type	Description
DataProduct.AccessGroup

getAccessGroupsOrThrow(String key)

public abstract DataProduct.AccessGroup getAccessGroupsOrThrow(String key)

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: <code><code> { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts&#64;example.com" } } } </code></code>

map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
DataProduct.AccessGroup

getAssetCount()

public abstract int getAssetCount()

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

int32 asset_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The assetCount.

getCreateTime()

public abstract Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. Description of the data product.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description of the data product.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getEtag()

public abstract String 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 etag = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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 etag = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for etag.

getIcon()

public abstract ByteString 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.

bytes icon = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The icon.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. User-defined labels for the data product.

Example: <code><code> { "environment": "production", "billing": "marketing-department" } </code></code>

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. User-defined labels for the data product.

Example: <code><code> { "environment": "production", "billing": "marketing-department" } </code></code>

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the data product.

Example: <code><code> { "environment": "production", "billing": "marketing-department" } </code></code>

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. User-defined labels for the data product.

Example: <code><code> { "environment": "production", "billing": "marketing-department" } </code></code>

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getOwnerEmails(int index)

public abstract String getOwnerEmails(int index)

Required. Emails of the data product owners.

repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The ownerEmails at the given index.

getOwnerEmailsBytes(int index)

public abstract ByteString getOwnerEmailsBytes(int index)

Required. Emails of the data product owners.

repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the ownerEmails at the given index.

getOwnerEmailsCount()

public abstract int getOwnerEmailsCount()

Required. Emails of the data product owners.

repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of ownerEmails.

getOwnerEmailsList()

public abstract List<String> getOwnerEmailsList()

Required. Emails of the data product owners.

repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<String>	A list containing the ownerEmails.

getUid()

public abstract String 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 uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

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 uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.