Package com.google.cloud.dataplex.v1

Interface DataProductOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DataProduct, DataProduct.Builder
@Generated public interface DataProductOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getUid

      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:
      The uid.

    • getUidBytes

      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) = { ... }
      Returns:
      The bytes for uid.

    • getDisplayName

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

    • getDisplayNameBytes

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

    • hasCreateTime

      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:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • getEtag

      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:
      The etag.

    • getEtagBytes

      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];
      Returns:
      The bytes for etag.

    • getLabelsCount

      int getLabelsCount()
       Optional. User-defined labels for the data product.

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

    • containsLabels

      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];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      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];

    • getLabelsOrDefault

      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];

    • getLabelsOrThrow

      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];

    • getDescription

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

    • getDescriptionBytes

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

    • getIcon

      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];
      Returns:
      The icon.

    • getOwnerEmailsList

      List<String> getOwnerEmailsList()
       Required. Emails of the data product owners.
      repeated string owner_emails = 11 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the ownerEmails.

    • getOwnerEmailsCount

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

    • getOwnerEmails

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

    • getOwnerEmailsBytes

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

    • getAssetCount

      int getAssetCount()
       Output only. Number of data assets associated with this data product.
      int32 asset_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The assetCount.

    • getAccessGroupsCount

      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:
 ```
 {
 "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];

    • containsAccessGroups

      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];

    • getAccessGroups

      @Deprecated Map<String,DataProduct.AccessGroup> getAccessGroups()
      Deprecated.
      Use getAccessGroupsMap() instead.

    • getAccessGroupsMap

      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];

    • getAccessGroupsOrDefault

      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];

    • getAccessGroupsOrThrow

      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];