public static final class DataProduct.Builder extends GeneratedMessage.Builder<DataProduct.Builder> implements DataProductOrBuilderA 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.
Protobuf type google.cloud.dataplex.v1.DataProduct
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DataProduct.BuilderImplements
DataProductOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllOwnerEmails(Iterable<String> values)
public DataProduct.Builder addAllOwnerEmails(Iterable<String> values)Required. Emails of the data product owners.
repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The ownerEmails to add. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
addOwnerEmails(String value)
public DataProduct.Builder addOwnerEmails(String value)Required. Emails of the data product owners.
repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe ownerEmails to add. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
addOwnerEmailsBytes(ByteString value)
public DataProduct.Builder addOwnerEmailsBytes(ByteString value)Required. Emails of the data product owners.
repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the ownerEmails to add. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
build()
public DataProduct build()| Returns | |
|---|---|
| Type | Description |
DataProduct |
|
buildPartial()
public DataProduct buildPartial()| Returns | |
|---|---|
| Type | Description |
DataProduct |
|
clear()
public DataProduct.Builder clear()| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
clearAccessGroups()
public DataProduct.Builder clearAccessGroups()| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
clearAssetCount()
public DataProduct.Builder clearAssetCount()Output only. Number of data assets associated with this data product.
int32 asset_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
clearCreateTime()
public DataProduct.Builder clearCreateTime()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 |
DataProduct.Builder |
|
clearDescription()
public DataProduct.Builder clearDescription()Optional. Description of the data product.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
clearDisplayName()
public DataProduct.Builder clearDisplayName()Required. User-friendly display name of the data product.
string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
clearEtag()
public DataProduct.Builder clearEtag()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 |
DataProduct.Builder |
This builder for chaining. |
clearIcon()
public DataProduct.Builder clearIcon()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 |
DataProduct.Builder |
This builder for chaining. |
clearLabels()
public DataProduct.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
clearName()
public DataProduct.Builder clearName() 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 |
DataProduct.Builder |
This builder for chaining. |
clearOwnerEmails()
public DataProduct.Builder clearOwnerEmails()Required. Emails of the data product owners.
repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
clearUid()
public DataProduct.Builder clearUid()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 |
DataProduct.Builder |
This builder for chaining. |
clearUpdateTime()
public DataProduct.Builder clearUpdateTime()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 |
DataProduct.Builder |
|
containsAccessGroups(String key)
public 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@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 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 Map<String,DataProduct.AccessGroup> getAccessGroups()Use #getAccessGroupsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,AccessGroup> |
|
getAccessGroupsCount()
public 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@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 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@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 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@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 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@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 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 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()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 |
Builder |
|
getCreateTimeOrBuilder()
public 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 |
|
getDefaultInstanceForType()
public DataProduct getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DataProduct |
|
getDescription()
public String getDescription()Optional. Description of the data product.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. Description of the data product.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public 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 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 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 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 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 Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public 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 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 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 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 |
|
getMutableAccessGroups() (deprecated)
public Map<String,DataProduct.AccessGroup> getMutableAccessGroups()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,AccessGroup> |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public 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 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 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The ownerEmails at the given index. |
getOwnerEmailsBytes(int index)
public 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the ownerEmails at the given index. |
getOwnerEmailsCount()
public 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 ProtocolStringList getOwnerEmailsList()Required. Emails of the data product owners.
repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the ownerEmails. |
getUid()
public 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 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 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder |
|
getUpdateTimeOrBuilder()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value)
public DataProduct.Builder mergeCreateTime(Timestamp value)Output only. The time at which the data product was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
mergeFrom(DataProduct other)
public DataProduct.Builder mergeFrom(DataProduct other)| Parameter | |
|---|---|
| Name | Description |
other |
DataProduct |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DataProduct.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DataProduct.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
mergeUpdateTime(Timestamp value)
public DataProduct.Builder mergeUpdateTime(Timestamp value)Output only. The time at which the data product was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
putAccessGroups(String key, DataProduct.AccessGroup value)
public DataProduct.Builder putAccessGroups(String key, DataProduct.AccessGroup value)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@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 |
value |
DataProduct.AccessGroup |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
putAccessGroupsBuilderIfAbsent(String key)
public DataProduct.AccessGroup.Builder putAccessGroupsBuilderIfAbsent(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@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.Builder |
|
putAllAccessGroups(Map<String,DataProduct.AccessGroup> values)
public DataProduct.Builder putAllAccessGroups(Map<String,DataProduct.AccessGroup> values)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@example.com"
}
}
}
</code></code>
map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,AccessGroup> |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
putAllLabels(Map<String,String> values)
public DataProduct.Builder putAllLabels(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
putLabels(String key, String value)
public DataProduct.Builder putLabels(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
removeAccessGroups(String key)
public DataProduct.Builder removeAccessGroups(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@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.Builder |
|
removeLabels(String key)
public DataProduct.Builder removeLabels(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 |
DataProduct.Builder |
|
setAssetCount(int value)
public DataProduct.Builder setAssetCount(int value)Output only. Number of data assets associated with this data product.
int32 asset_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe assetCount to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public DataProduct.Builder setCreateTime(Timestamp value)Output only. The time at which the data product was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public DataProduct.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The time at which the data product was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
setDescription(String value)
public DataProduct.Builder setDescription(String value)Optional. Description of the data product.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public DataProduct.Builder setDescriptionBytes(ByteString value)Optional. Description of the data product.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setDisplayName(String value)
public DataProduct.Builder setDisplayName(String value)Required. User-friendly display name of the data product.
string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public DataProduct.Builder setDisplayNameBytes(ByteString value)Required. User-friendly display name of the data product.
string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setEtag(String value)
public DataProduct.Builder setEtag(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public DataProduct.Builder setEtagBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setIcon(ByteString value)
public DataProduct.Builder setIcon(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe icon to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setName(String value)
public DataProduct.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public DataProduct.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setOwnerEmails(int index, String value)
public DataProduct.Builder setOwnerEmails(int index, String value)Required. Emails of the data product owners.
repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe ownerEmails to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setUid(String value)
public DataProduct.Builder setUid(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe uid to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public DataProduct.Builder setUidBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for uid to set. |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
This builder for chaining. |
setUpdateTime(Timestamp value)
public DataProduct.Builder setUpdateTime(Timestamp value)Output only. The time at which the data product was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public DataProduct.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The time at which the data product was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
DataProduct.Builder |
|