Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataProduct (v2.10.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataProduct.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#access_approval_config

def access_approval_config() -> ::Google::Cloud::Dataplex::V1::DataProduct::AccessApprovalConfig
Returns

#access_approval_config=

def access_approval_config=(value) -> ::Google::Cloud::Dataplex::V1::DataProduct::AccessApprovalConfig
Parameter
Returns

#access_groups

def access_groups() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::DataProduct::AccessGroup}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::DataProduct::AccessGroup}) — 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" } } }

#access_groups=

def access_groups=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::DataProduct::AccessGroup}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::DataProduct::AccessGroup}) — 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" } } }

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::DataProduct::AccessGroup}) — 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" } } }

#asset_count

def asset_count() -> ::Integer
Returns
  • (::Integer) — Output only. Number of data assets associated with this data product.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description of the data product.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description of the data product.
Returns
  • (::String) — Optional. Description of the data product.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. User-friendly display name of the data product.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. User-friendly display name of the data product.
Returns
  • (::String) — Required. User-friendly display name of the data product.

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#icon

def icon() -> ::String
Returns
  • (::String) — 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.

#icon=

def icon=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the data product.

    Example: { "environment": "production", "billing": "marketing-department" }

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the data product.

    Example: { "environment": "production", "billing": "marketing-department" }

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the data product.

    Example: { "environment": "production", "billing": "marketing-department" }

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Resource name of the data product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Resource name of the data product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.
Returns
  • (::String) — Identifier. Resource name of the data product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.

#owner_emails

def owner_emails() -> ::Array<::String>
Returns
  • (::Array<::String>) — Required. Emails of the data product owners.

#owner_emails=

def owner_emails=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Required. Emails of the data product owners.
Returns
  • (::Array<::String>) — Required. Emails of the data product owners.

#uid

def uid() -> ::String
Returns
  • (::String) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns