public final class DataProduct extends GeneratedMessage implements DataProductOrBuilder
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.
Protobuf type google.cloud.dataplex.v1.DataProduct
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
ACCESS_GROUPS_FIELD_NUMBER
public static final int ACCESS_GROUPS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ASSET_COUNT_FIELD_NUMBER
public static final int ASSET_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ICON_FIELD_NUMBER
public static final int ICON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OWNER_EMAILS_FIELD_NUMBER
public static final int OWNER_EMAILS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DataProduct getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataProduct.Builder newBuilder()
newBuilder(DataProduct prototype)
public static DataProduct.Builder newBuilder(DataProduct prototype)
public static DataProduct parseDelimitedFrom(InputStream input)
public static DataProduct parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataProduct parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataProduct parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataProduct parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataProduct parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataProduct parseFrom(CodedInputStream input)
public static DataProduct parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataProduct parseFrom(InputStream input)
public static DataProduct parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataProduct parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataProduct parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataProduct> parser()
Methods
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
|
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAccessGroups() (deprecated)
public Map<String,DataProduct.AccessGroup> getAccessGroups()
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];
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];
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
|
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.
|
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];
getDefaultInstanceForType()
public DataProduct getDefaultInstanceForType()
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.
|
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()
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];
getLabels() (deprecated)
public Map<String,String> getLabels()
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];
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];
| 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 |
|
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 |
int
The 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 |
int
The 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];
getParserForType()
public Parser<DataProduct> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataProduct.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected DataProduct.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public DataProduct.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
