Package com.google.cloud.dataplex.v1

Class DataProduct

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.DataProduct
All Implemented Interfaces:
DataProductOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataProduct extends com.google.protobuf.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
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface DataProductOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface DataProductOrBuilder
      Returns:
      The bytes for name.

    • 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) = { ... }
      Specified by:
      getUid in interface DataProductOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getUidBytes in interface DataProductOrBuilder
      Returns:
      The bytes for uid.

    • getDisplayName

      public String getDisplayName()
       Required. User-friendly display name of the data product.
      string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface DataProductOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. User-friendly display name of the data product.
      string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface DataProductOrBuilder
      Returns:
      The bytes for displayName.

    • 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];
      Specified by:
      hasCreateTime in interface DataProductOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.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];
      Specified by:
      getCreateTime in interface DataProductOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getCreateTimeOrBuilder in interface DataProductOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface DataProductOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.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];
      Specified by:
      getUpdateTime in interface DataProductOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getUpdateTimeOrBuilder in interface DataProductOrBuilder

    • 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];
      Specified by:
      getEtag in interface DataProductOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.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];
      Specified by:
      getEtagBytes in interface DataProductOrBuilder
      Returns:
      The bytes for etag.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: DataProductOrBuilder
       Optional. User-defined labels for the data product.

 Example:
 ```
 {
 "environment": "production",
 "billing": "marketing-department"
 }
 ```
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface DataProductOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. User-defined labels for the data product.

 Example:
 ```
 {
 "environment": "production",
 "billing": "marketing-department"
 }
 ```
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface DataProductOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface DataProductOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. User-defined labels for the data product.

 Example:
 ```
 {
 "environment": "production",
 "billing": "marketing-department"
 }
 ```
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface DataProductOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. User-defined labels for the data product.

 Example:
 ```
 {
 "environment": "production",
 "billing": "marketing-department"
 }
 ```
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface DataProductOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. User-defined labels for the data product.

 Example:
 ```
 {
 "environment": "production",
 "billing": "marketing-department"
 }
 ```
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface DataProductOrBuilder

    • getDescription

      public String getDescription()
       Optional. Description of the data product.
      string description = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface DataProductOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the data product.
      string description = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface DataProductOrBuilder
      Returns:
      The bytes for description.

    • getIcon

      public com.google.protobuf.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];
      Specified by:
      getIcon in interface DataProductOrBuilder
      Returns:
      The icon.

    • getOwnerEmailsList

      public com.google.protobuf.ProtocolStringList getOwnerEmailsList()
       Required. Emails of the data product owners.
      repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOwnerEmailsList in interface DataProductOrBuilder
      Returns:
      A list containing the ownerEmails.

    • getOwnerEmailsCount

      public int getOwnerEmailsCount()
       Required. Emails of the data product owners.
      repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOwnerEmailsCount in interface DataProductOrBuilder
      Returns:
      The count of ownerEmails.

    • getOwnerEmails

      public String getOwnerEmails(int index)
       Required. Emails of the data product owners.
      repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOwnerEmails in interface DataProductOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The ownerEmails at the given index.

    • getOwnerEmailsBytes

      public com.google.protobuf.ByteString getOwnerEmailsBytes(int index)
       Required. Emails of the data product owners.
      repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOwnerEmailsBytes in interface DataProductOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ownerEmails at the given index.

    • 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];
      Specified by:
      getAssetCount in interface DataProductOrBuilder
      Returns:
      The assetCount.

    • getAccessGroupsCount

      public int getAccessGroupsCount()
      Description copied from interface: DataProductOrBuilder
       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"
 }
 }
 }
 ```
      map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAccessGroupsCount in interface DataProductOrBuilder

    • containsAccessGroups

      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:
 ```
 {
 "analyst": {
 "id": "analyst",
 "displayName": "Analyst",
 "description": "Access group for analysts",
 "principal": {
 "googleGroup": "analysts@example.com"
 }
 }
 }
 ```
      map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsAccessGroups in interface DataProductOrBuilder

    • getAccessGroups

      @Deprecated public Map<String,DataProduct.AccessGroup> getAccessGroups()
      Deprecated.
      Use getAccessGroupsMap() instead.
      Specified by:
      getAccessGroups in interface DataProductOrBuilder

    • 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:
 ```
 {
 "analyst": {
 "id": "analyst",
 "displayName": "Analyst",
 "description": "Access group for analysts",
 "principal": {
 "googleGroup": "analysts@example.com"
 }
 }
 }
 ```
      map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAccessGroupsMap in interface DataProductOrBuilder

    • getAccessGroupsOrDefault

      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:
 ```
 {
 "analyst": {
 "id": "analyst",
 "displayName": "Analyst",
 "description": "Access group for analysts",
 "principal": {
 "googleGroup": "analysts@example.com"
 }
 }
 }
 ```
      map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAccessGroupsOrDefault in interface DataProductOrBuilder

    • getAccessGroupsOrThrow

      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:
 ```
 {
 "analyst": {
 "id": "analyst",
 "displayName": "Analyst",
 "description": "Access group for analysts",
 "principal": {
 "googleGroup": "analysts@example.com"
 }
 }
 }
 ```
      map<string, .google.cloud.dataplex.v1.DataProduct.AccessGroup> access_groups = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAccessGroupsOrThrow in interface DataProductOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DataProduct parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataProduct parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataProduct parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataProduct parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataProduct parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataProduct parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataProduct parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataProduct parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataProduct parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataProduct parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataProduct parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataProduct parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DataProduct.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DataProduct.Builder newBuilder()

    • newBuilder

      public static DataProduct.Builder newBuilder(DataProduct prototype)

    • toBuilder

      public DataProduct.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DataProduct.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataProduct getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DataProduct> parser()

    • getParserForType

      public com.google.protobuf.Parser<DataProduct> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DataProduct getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder