Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataTaxonomyService::Rest::Client (v0.13.0)

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

REST client for the DataTaxonomyService service.

DataTaxonomyService enables attribute-based governance. The resources currently offered include DataTaxonomy and DataAttribute.

Inherits

Object

Includes

Google::Cloud::Dataplex::V1::DataTaxonomyService::Paths

Methods

.configure

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

Configure the DataTaxonomyService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all DataTaxonomyService clients
::Google::Cloud::Dataplex::V1::DataTaxonomyService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the DataTaxonomyService 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

config (Client::Configuration)

Returns

(Client::Configuration)

#create_data_attribute

def create_data_attribute(request, options = nil) -> ::Gapic::Operation
def create_data_attribute(parent: nil, data_attribute_id: nil, data_attribute: nil, validate_only: nil) -> ::Gapic::Operation

Create a DataAttribute resource.

Overloads

def create_data_attribute(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_data_attribute via a request object, either of type CreateDataAttributeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::CreateDataAttributeRequest, ::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_attribute(parent: nil, data_attribute_id: nil, data_attribute: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to create_data_attribute 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 parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
data_attribute_id (::String) —
Required. DataAttribute identifier.
- Must contain only lowercase letters, numbers and hyphens.
- Must start with a letter.
- Must be between 1-63 characters.
- Must end with a number or a letter.
- Must be unique within the DataTaxonomy.
data_attribute (::Google::Cloud::Dataplex::V1::DataAttribute, ::Hash) — Required. DataAttribute resource.
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the create_data_attribute method.
result = client.create_data_attribute 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_attribute_binding

def create_data_attribute_binding(request, options = nil) -> ::Gapic::Operation
def create_data_attribute_binding(parent: nil, data_attribute_binding_id: nil, data_attribute_binding: nil, validate_only: nil) -> ::Gapic::Operation

Create a DataAttributeBinding resource.

Overloads

def create_data_attribute_binding(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_data_attribute_binding via a request object, either of type CreateDataAttributeBindingRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::CreateDataAttributeBindingRequest, ::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_attribute_binding(parent: nil, data_attribute_binding_id: nil, data_attribute_binding: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to create_data_attribute_binding 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 parent data taxonomy projects/{project_number}/locations/{location_id}
data_attribute_binding_id (::String) —
Required. DataAttributeBinding identifier.
- Must contain only lowercase letters, numbers and hyphens.
- Must start with a letter.
- Must be between 1-63 characters.
- Must end with a number or a letter.
- Must be unique within the Location.
data_attribute_binding (::Google::Cloud::Dataplex::V1::DataAttributeBinding, ::Hash) — Required. DataAttributeBinding resource.
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the create_data_attribute_binding method.
result = client.create_data_attribute_binding 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_taxonomy

def create_data_taxonomy(request, options = nil) -> ::Gapic::Operation
def create_data_taxonomy(parent: nil, data_taxonomy_id: nil, data_taxonomy: nil, validate_only: nil) -> ::Gapic::Operation

Create a DataTaxonomy resource.

Overloads

def create_data_taxonomy(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_data_taxonomy via a request object, either of type CreateDataTaxonomyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::CreateDataTaxonomyRequest, ::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_taxonomy(parent: nil, data_taxonomy_id: nil, data_taxonomy: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to create_data_taxonomy 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 taxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
data_taxonomy_id (::String) —
Required. DataTaxonomy identifier.
- Must contain only lowercase letters, numbers and hyphens.
- Must start with a letter.
- Must be between 1-63 characters.
- Must end with a number or a letter.
- Must be unique within the Project.
data_taxonomy (::Google::Cloud::Dataplex::V1::DataTaxonomy, ::Hash) — Required. DataTaxonomy resource.
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the create_data_taxonomy method.
result = client.create_data_taxonomy 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_attribute

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

Deletes a Data Attribute resource.

Overloads

def delete_data_attribute(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_data_attribute via a request object, either of type Google::Cloud::Dataplex::V1::DeleteDataAttributeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::DeleteDataAttributeRequest, ::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_attribute(name: nil, etag: nil) -> ::Gapic::Operation

Pass arguments to delete_data_attribute 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 resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
etag (::String) — Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the delete_data_attribute method.
result = client.delete_data_attribute 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_attribute_binding

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

Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.

Overloads

def delete_data_attribute_binding(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_data_attribute_binding via a request object, either of type Google::Cloud::Dataplex::V1::DeleteDataAttributeBindingRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::DeleteDataAttributeBindingRequest, ::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_attribute_binding(name: nil, etag: nil) -> ::Gapic::Operation

Pass arguments to delete_data_attribute_binding 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 resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}
etag (::String) — Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the delete_data_attribute_binding method.
result = client.delete_data_attribute_binding 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_taxonomy

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

Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.

Overloads

def delete_data_taxonomy(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_data_taxonomy via a request object, either of type Google::Cloud::Dataplex::V1::DeleteDataTaxonomyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::DeleteDataTaxonomyRequest, ::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_taxonomy(name: nil, etag: nil) -> ::Gapic::Operation

Pass arguments to delete_data_taxonomy 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 resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
etag (::String) — Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the delete_data_taxonomy method.
result = client.delete_data_taxonomy 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_attribute

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

Retrieves a Data Attribute resource.

Overloads

def get_data_attribute(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataAttribute

Pass arguments to get_data_attribute via a request object, either of type GetDataAttributeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::GetDataAttributeRequest, ::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_attribute(name: nil) -> ::Google::Cloud::Dataplex::V1::DataAttribute

Pass arguments to get_data_attribute 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 resource name of the dataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dataplex::V1::DataAttribute)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dataplex::V1::DataAttribute)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

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

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

#get_data_attribute_binding

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

Retrieves a DataAttributeBinding resource.

Overloads

def get_data_attribute_binding(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataAttributeBinding

Pass arguments to get_data_attribute_binding via a request object, either of type GetDataAttributeBindingRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::GetDataAttributeBindingRequest, ::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_attribute_binding(name: nil) -> ::Google::Cloud::Dataplex::V1::DataAttributeBinding

Pass arguments to get_data_attribute_binding 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 resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dataplex::V1::DataAttributeBinding)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dataplex::V1::DataAttributeBinding)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

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

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

#get_data_taxonomy

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

Retrieves a DataTaxonomy resource.

Overloads

def get_data_taxonomy(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataTaxonomy

Pass arguments to get_data_taxonomy via a request object, either of type GetDataTaxonomyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::GetDataTaxonomyRequest, ::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_taxonomy(name: nil) -> ::Google::Cloud::Dataplex::V1::DataTaxonomy

Pass arguments to get_data_taxonomy 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 resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dataplex::V1::DataTaxonomy)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dataplex::V1::DataTaxonomy)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

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

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

#iam_policy_client

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

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

Returns

(Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

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

Create a new DataTaxonomyService REST client object.

Yields

(config) — Configure the DataTaxonomyService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Dataplex::V1::DataTaxonomyService::Rest::Client.new

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

#list_data_attribute_bindings

def list_data_attribute_bindings(request, options = nil) -> ::Google::Cloud::Dataplex::V1::ListDataAttributeBindingsResponse
def list_data_attribute_bindings(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Dataplex::V1::ListDataAttributeBindingsResponse

Lists DataAttributeBinding resources in a project and location.

Overloads

def list_data_attribute_bindings(request, options = nil) -> ::Google::Cloud::Dataplex::V1::ListDataAttributeBindingsResponse

Pass arguments to list_data_attribute_bindings via a request object, either of type ListDataAttributeBindingsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::ListDataAttributeBindingsRequest, ::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_attribute_bindings(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Dataplex::V1::ListDataAttributeBindingsResponse

Pass arguments to list_data_attribute_bindings 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 Location: projects/{project_number}/locations/{location_id}
page_size (::Integer) — Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token (::String) — Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token.
filter (::String) — Optional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name"
order_by (::String) — Optional. Order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dataplex::V1::ListDataAttributeBindingsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dataplex::V1::ListDataAttributeBindingsResponse)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the list_data_attribute_bindings method.
result = client.list_data_attribute_bindings 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::DataAttributeBinding.
  p item
end

#list_data_attributes

def list_data_attributes(request, options = nil) -> ::Google::Cloud::Dataplex::V1::ListDataAttributesResponse
def list_data_attributes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Dataplex::V1::ListDataAttributesResponse

Lists Data Attribute resources in a DataTaxonomy.

Overloads

def list_data_attributes(request, options = nil) -> ::Google::Cloud::Dataplex::V1::ListDataAttributesResponse

Pass arguments to list_data_attributes via a request object, either of type ListDataAttributesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::ListDataAttributesRequest, ::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_attributes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Dataplex::V1::ListDataAttributesResponse

Pass arguments to list_data_attributes 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 DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
page_size (::Integer) — Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token (::String) — Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token.
filter (::String) — Optional. Filter request.
order_by (::String) — Optional. Order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dataplex::V1::ListDataAttributesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dataplex::V1::ListDataAttributesResponse)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the list_data_attributes method.
result = client.list_data_attributes 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::DataAttribute.
  p item
end

#list_data_taxonomies

def list_data_taxonomies(request, options = nil) -> ::Google::Cloud::Dataplex::V1::ListDataTaxonomiesResponse
def list_data_taxonomies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Dataplex::V1::ListDataTaxonomiesResponse

Lists DataTaxonomy resources in a project and location.

Overloads

def list_data_taxonomies(request, options = nil) -> ::Google::Cloud::Dataplex::V1::ListDataTaxonomiesResponse

Pass arguments to list_data_taxonomies via a request object, either of type ListDataTaxonomiesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::ListDataTaxonomiesRequest, ::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_taxonomies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Dataplex::V1::ListDataTaxonomiesResponse

Pass arguments to list_data_taxonomies 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 DataTaxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
page_size (::Integer) — Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token (::String) — Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token.
filter (::String) — Optional. Filter request.
order_by (::String) — Optional. Order by fields for the result.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dataplex::V1::ListDataTaxonomiesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dataplex::V1::ListDataTaxonomiesResponse)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the list_data_taxonomies method.
result = client.list_data_taxonomies 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::DataTaxonomy.
  p item
end

#location_client

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

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

Returns

(Google::Cloud::Location::Locations::Rest::Client)

#operations_client

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

Get the associated client for long-running operations.

Returns

(::Google::Cloud::Dataplex::V1::DataTaxonomyService::Rest::Operations)

#update_data_attribute

def update_data_attribute(request, options = nil) -> ::Gapic::Operation
def update_data_attribute(update_mask: nil, data_attribute: nil, validate_only: nil) -> ::Gapic::Operation

Updates a DataAttribute resource.

Overloads

def update_data_attribute(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_data_attribute via a request object, either of type UpdateDataAttributeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::UpdateDataAttributeRequest, ::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_attribute(update_mask: nil, data_attribute: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to update_data_attribute 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

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Mask of fields to update.
data_attribute (::Google::Cloud::Dataplex::V1::DataAttribute, ::Hash) — Required. Only fields specified in update_mask are updated.
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the update_data_attribute method.
result = client.update_data_attribute 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_attribute_binding

def update_data_attribute_binding(request, options = nil) -> ::Gapic::Operation
def update_data_attribute_binding(update_mask: nil, data_attribute_binding: nil, validate_only: nil) -> ::Gapic::Operation

Updates a DataAttributeBinding resource.

Overloads

def update_data_attribute_binding(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_data_attribute_binding via a request object, either of type UpdateDataAttributeBindingRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::UpdateDataAttributeBindingRequest, ::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_attribute_binding(update_mask: nil, data_attribute_binding: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to update_data_attribute_binding 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

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Mask of fields to update.
data_attribute_binding (::Google::Cloud::Dataplex::V1::DataAttributeBinding, ::Hash) — Required. Only fields specified in update_mask are updated.
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the update_data_attribute_binding method.
result = client.update_data_attribute_binding 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_taxonomy

def update_data_taxonomy(request, options = nil) -> ::Gapic::Operation
def update_data_taxonomy(update_mask: nil, data_taxonomy: nil, validate_only: nil) -> ::Gapic::Operation

Updates a DataTaxonomy resource.

Overloads

def update_data_taxonomy(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_data_taxonomy via a request object, either of type UpdateDataTaxonomyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::UpdateDataTaxonomyRequest, ::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_taxonomy(update_mask: nil, data_taxonomy: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to update_data_taxonomy 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

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Mask of fields to update.
data_taxonomy (::Google::Cloud::Dataplex::V1::DataTaxonomy, ::Hash) — Required. Only fields specified in update_mask are updated.
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::DataTaxonomyService::Rest::Client.new

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

# Call the update_data_taxonomy method.
result = client.update_data_taxonomy 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