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

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

Client for the DataProductService service.

DataProductService provides APIs for managing data products and the underlying data assets.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the DataProductService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all DataProductService clients
::Google::Cloud::Dataplex::V1::DataProductService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the DataProductService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_data_asset

def create_data_asset(request, options = nil) -> ::Gapic::Operation
def create_data_asset(parent: nil, data_asset_id: nil, data_asset: nil, validate_only: nil) -> ::Gapic::Operation

Creates a data asset.

Overloads 
def create_data_asset(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_data_asset via a request object, either of type CreateDataAssetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::CreateDataAssetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_data_asset(parent: nil, data_asset_id: nil, data_asset: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_data_asset via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource where this data asset will be created. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
  • data_asset_id (::String) — Optional. The ID of the data asset to create.

    The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$ If not provided, a system generated ID will be used.

  • data_asset (::Google::Cloud::Dataplex::V1::DataAsset, ::Hash) — Required. The data asset to create.
  • validate_only (::Boolean) — Optional. Validates the request without actually creating the data asset. Defaults to false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::CreateDataAssetRequest.new

# Call the create_data_asset method.
result = client.create_data_asset request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_data_product

def create_data_product(request, options = nil) -> ::Gapic::Operation
def create_data_product(parent: nil, data_product_id: nil, data_product: nil, validate_only: nil) -> ::Gapic::Operation

Creates a data product.

Overloads 
def create_data_product(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_data_product via a request object, either of type CreateDataProductRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::CreateDataProductRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_data_product(parent: nil, data_product_id: nil, data_product: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_data_product via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource where this data product will be created. Format: projects/{project_id_or_number}/locations/{location_id}
  • data_product_id (::String) — Optional. The ID of the data product to create.

    The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$ If not provided, a system generated ID will be used.

  • data_product (::Google::Cloud::Dataplex::V1::DataProduct, ::Hash) — Required. The data product to create.
  • validate_only (::Boolean) — Optional. Validates the request without actually creating the data product. Default: false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::CreateDataProductRequest.new

# Call the create_data_product method.
result = client.create_data_product request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_data_asset

def delete_data_asset(request, options = nil) -> ::Gapic::Operation
def delete_data_asset(name: nil, etag: nil, validate_only: nil) -> ::Gapic::Operation

Deletes a data asset.

Overloads 
def delete_data_asset(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_data_asset via a request object, either of type Google::Cloud::Dataplex::V1::DeleteDataAssetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::DeleteDataAssetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_data_asset(name: nil, etag: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to delete_data_asset via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the data asset to delete. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
  • etag (::String) — Optional. The etag of the data asset. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
  • validate_only (::Boolean) — Optional. Validates the request without actually deleting the data asset. Defaults to false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::DeleteDataAssetRequest.new

# Call the delete_data_asset method.
result = client.delete_data_asset request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_data_product

def delete_data_product(request, options = nil) -> ::Gapic::Operation
def delete_data_product(name: nil, etag: nil, validate_only: nil) -> ::Gapic::Operation

Deletes a data product. The deletion will fail if the data product is not empty (i.e. contains at least one data asset).

Overloads 
def delete_data_product(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_data_product via a request object, either of type Google::Cloud::Dataplex::V1::DeleteDataProductRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::DeleteDataProductRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_data_product(name: nil, etag: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to delete_data_product via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the data product to delete. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
  • etag (::String) — Optional. The etag of the data product.

    If an etag is provided and does not match the current etag of the data product, then the deletion will be blocked and an ABORTED error will be returned.

  • validate_only (::Boolean) — Optional. Validates the request without actually deleting the data product. Default: false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::DeleteDataProductRequest.new

# Call the delete_data_product method.
result = client.delete_data_product request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_data_asset

def get_data_asset(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataAsset
def get_data_asset(name: nil) -> ::Google::Cloud::Dataplex::V1::DataAsset

Gets a data asset.

Overloads 
def get_data_asset(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataAsset
Pass arguments to get_data_asset via a request object, either of type GetDataAssetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::GetDataAssetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_data_asset(name: nil) -> ::Google::Cloud::Dataplex::V1::DataAsset
Pass arguments to get_data_asset via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the data asset to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::GetDataAssetRequest.new

# Call the get_data_asset method.
result = client.get_data_asset request

# The returned object is of type Google::Cloud::Dataplex::V1::DataAsset.
p result

#get_data_product

def get_data_product(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataProduct
def get_data_product(name: nil) -> ::Google::Cloud::Dataplex::V1::DataProduct

Gets a data product.

Overloads 
def get_data_product(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataProduct
Pass arguments to get_data_product via a request object, either of type GetDataProductRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::GetDataProductRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_data_product(name: nil) -> ::Google::Cloud::Dataplex::V1::DataProduct
Pass arguments to get_data_product via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the data product to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::GetDataProductRequest.new

# Call the get_data_product method.
result = client.get_data_product request

# The returned object is of type Google::Cloud::Dataplex::V1::DataProduct.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new DataProductService client object.

Yields
  • (config) — Configure the DataProductService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dataplex::V1::DataProductService::Client.new do |config|
  config.timeout = 10.0
end

#list_data_assets

def list_data_assets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataAsset>
def list_data_assets(parent: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataAsset>

Lists data assets for a given data product.

Overloads 
def list_data_assets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataAsset>
Pass arguments to list_data_assets via a request object, either of type ListDataAssetsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::ListDataAssetsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_data_assets(parent: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataAsset>
Pass arguments to list_data_assets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which has this collection of data assets. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
  • filter (::String) — Optional. Filter expression that filters data assets listed in the response.
  • order_by (::String) — Optional. Order by expression that orders data assets listed in the response.

    Supported order_by fields are: name or create_time.

    If not specified, the ordering is undefined.

  • page_size (::Integer) — Optional. The maximum number of data assets to return. The service may return fewer than this value. If unspecified, at most 50 data assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A page token, received from a previous ListDataAssets call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDataAssets must match the call that provided the page token.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::ListDataAssetsRequest.new

# Call the list_data_assets method.
result = client.list_data_assets request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataplex::V1::DataAsset.
  p item
end

#list_data_products

def list_data_products(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataProduct>
def list_data_products(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataProduct>

Lists data products for a given project.

Overloads 
def list_data_products(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataProduct>
Pass arguments to list_data_products via a request object, either of type ListDataProductsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::ListDataProductsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_data_products(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataProduct>
Pass arguments to list_data_products via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which has this collection of data products.

    Format: projects/{project_id_or_number}/locations/{location_id}.

    Supports listing across all locations with the wildcard - (hyphen) character. Example: projects/{project_id_or_number}/locations/-

  • filter (::String) — Optional. Filter expression that filters data products listed in the response.

    Example of using this filter is: display_name="my-data-product"

  • page_size (::Integer) — Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A page token, received from a previous ListDataProducts call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDataProducts must match the call that provided the page token.

  • order_by (::String) — Optional. Order by expression that orders data products listed in the response.

    Supported Order by fields are: name or create_time.

    If not specified, the ordering is undefined.

    Ordering by create_time is not supported when listing resources across locations (i.e. when request contains /locations/-).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::ListDataProductsRequest.new

# Call the list_data_products method.
result = client.list_data_products request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataplex::V1::DataProduct.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::Dataplex::V1::DataProductService::Operations

Get the associated client for long-running operations.

Returns

#request_data_product_access

def request_data_product_access(request, options = nil) -> ::Google::Cloud::Dataplex::V1::RequestDataProductAccessResponse
def request_data_product_access(parent: nil, change_request: nil, validate_only: nil) -> ::Google::Cloud::Dataplex::V1::RequestDataProductAccessResponse

Requests access to a data product. This will trigger an access approval workflow, and the requester will need to wait for the approval to be granted before they will be able to access the data product assets.

Overloads 
def request_data_product_access(request, options = nil) -> ::Google::Cloud::Dataplex::V1::RequestDataProductAccessResponse
Pass arguments to request_data_product_access via a request object, either of type RequestDataProductAccessRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::RequestDataProductAccessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def request_data_product_access(parent: nil, change_request: nil, validate_only: nil) -> ::Google::Cloud::Dataplex::V1::RequestDataProductAccessResponse
Pass arguments to request_data_product_access via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
  • change_request (::Google::Cloud::Dataplex::V1::ChangeRequest, ::Hash) — Required. The change request for the data product access request.
  • validate_only (::Boolean) — Optional. Validates the request without actually creating the access change request. Defaults to false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::RequestDataProductAccessRequest.new

# Call the request_data_product_access method.
result = client.request_data_product_access request

# The returned object is of type Google::Cloud::Dataplex::V1::RequestDataProductAccessResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_data_asset

def update_data_asset(request, options = nil) -> ::Gapic::Operation
def update_data_asset(data_asset: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation

Updates a data asset.

Overloads 
def update_data_asset(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_data_asset via a request object, either of type UpdateDataAssetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::UpdateDataAssetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_data_asset(data_asset: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to update_data_asset via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • data_asset (::Google::Cloud::Dataplex::V1::DataAsset, ::Hash) — Required. The data asset to update. The data asset's name field is used to identify the data asset to update.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update. If this is empty or not set, then all the fields will be updated.
  • validate_only (::Boolean) — Optional. Validates the request without actually updating the data asset. Defaults to false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::UpdateDataAssetRequest.new

# Call the update_data_asset method.
result = client.update_data_asset request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_data_product

def update_data_product(request, options = nil) -> ::Gapic::Operation
def update_data_product(data_product: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation

Updates a data product.

Overloads 
def update_data_product(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_data_product via a request object, either of type UpdateDataProductRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::UpdateDataProductRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_data_product(data_product: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to update_data_product via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • data_product (::Google::Cloud::Dataplex::V1::DataProduct, ::Hash) — Required. The data product to update. The data product's name field is used to identify the data product to update.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update. If this is empty or not set, then all the fields will be updated.
  • validate_only (::Boolean) — Optional. Validates the request without actually updating the data product. Default: false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::DataProductService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::UpdateDataProductRequest.new

# Call the update_data_product method.
result = client.update_data_product request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end