Google Cloud Data Catalog V1BETA1 API - Class Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::Client (v0.4.0)

Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::Client.

REST client for the PolicyTagManagerSerialization service.

Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the PolicyTagManagerSerialization 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 PolicyTagManagerSerialization clients
::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

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

#export_taxonomies

def export_taxonomies(request, options = nil) -> ::Google::Cloud::DataCatalog::V1beta1::ExportTaxonomiesResponse
def export_taxonomies(parent: nil, taxonomies: nil, serialized_taxonomies: nil) -> ::Google::Cloud::DataCatalog::V1beta1::ExportTaxonomiesResponse

Exports all taxonomies and their policy tags in a project.

This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls.

Overloads 
def export_taxonomies(request, options = nil) -> ::Google::Cloud::DataCatalog::V1beta1::ExportTaxonomiesResponse
Pass arguments to export_taxonomies via a request object, either of type ExportTaxonomiesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DataCatalog::V1beta1::ExportTaxonomiesRequest, ::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 export_taxonomies(parent: nil, taxonomies: nil, serialized_taxonomies: nil) -> ::Google::Cloud::DataCatalog::V1beta1::ExportTaxonomiesResponse
Pass arguments to export_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. Resource name of the project that taxonomies to be exported will share.
  • taxonomies (::Array<::String>) — Required. Resource names of the taxonomies to be exported.
  • serialized_taxonomies (::Boolean) — Export taxonomies as serialized taxonomies.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/data_catalog/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1beta1::ExportTaxonomiesRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1beta1::ExportTaxonomiesResponse.
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)

#import_taxonomies

def import_taxonomies(request, options = nil) -> ::Google::Cloud::DataCatalog::V1beta1::ImportTaxonomiesResponse
def import_taxonomies(parent: nil, inline_source: nil) -> ::Google::Cloud::DataCatalog::V1beta1::ImportTaxonomiesResponse

Imports all taxonomies and their policy tags to a project as new taxonomies.

This method provides a bulk taxonomy / policy tag creation using nested proto structure.

Overloads 
def import_taxonomies(request, options = nil) -> ::Google::Cloud::DataCatalog::V1beta1::ImportTaxonomiesResponse
Pass arguments to import_taxonomies via a request object, either of type ImportTaxonomiesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DataCatalog::V1beta1::ImportTaxonomiesRequest, ::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 import_taxonomies(parent: nil, inline_source: nil) -> ::Google::Cloud::DataCatalog::V1beta1::ImportTaxonomiesResponse
Pass arguments to import_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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/data_catalog/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1beta1::ImportTaxonomiesRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1beta1::ImportTaxonomiesResponse.
p result

#initialize

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

Create a new PolicyTagManagerSerialization REST client object.

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

# Create a client using a custom configuration
client = ::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::Client.new do |config|
  config.timeout = 10.0
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)