class Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client

Client for the PolicyTagManagerSerialization service.

Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

Attributes

policy_tag_manager_serialization_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the PolicyTagManagerSerialization Client class.

See {::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb, line 59
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DataCatalog", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new PolicyTagManagerSerialization client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client.new

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

@yield [config] Configure the PolicyTagManagerSerialization client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb, line 114
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @policy_tag_manager_serialization_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb, line 93
def configure
  yield @config if block_given?
  @config
end
export_taxonomies(request, options = nil) { |response, operation| ... } click to toggle source

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls.

@overload export_taxonomies(request, options = nil)

Pass arguments to `export_taxonomies` via a request object, either of type
{::Google::Cloud::DataCatalog::V1::ExportTaxonomiesRequest} or an equivalent Hash.

@param request [::Google::Cloud::DataCatalog::V1::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload export_taxonomies(parent: nil, taxonomies: nil, serialized_taxonomies: nil)

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).

@param parent [::String]
  Required. Resource name of the project that the exported taxonomies belong to.
@param taxonomies [::Array<::String>]
  Required. Resource names of the taxonomies to export.
@param serialized_taxonomies [::Boolean]
  Serialized export taxonomies that contain all the policy
  tags as nested protocol buffers.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataCatalog::V1::ExportTaxonomiesResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataCatalog::V1::ExportTaxonomiesResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb, line 352
def export_taxonomies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ExportTaxonomiesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.export_taxonomies.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.export_taxonomies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.export_taxonomies.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @policy_tag_manager_serialization_stub.call_rpc :export_taxonomies, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
import_taxonomies(request, options = nil) { |response, operation| ... } click to toggle source

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

@overload import_taxonomies(request, options = nil)

Pass arguments to `import_taxonomies` via a request object, either of type
{::Google::Cloud::DataCatalog::V1::ImportTaxonomiesRequest} or an equivalent Hash.

@param request [::Google::Cloud::DataCatalog::V1::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload import_taxonomies(parent: nil, inline_source: nil, cross_regional_source: nil)

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).

@param parent [::String]
  Required. Resource name of project that the imported taxonomies will belong to.
@param inline_source [::Google::Cloud::DataCatalog::V1::InlineSource, ::Hash]
  Inline source taxonomy to import.
@param cross_regional_source [::Google::Cloud::DataCatalog::V1::CrossRegionalSource, ::Hash]
  Cross-regional source taxonomy to import.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataCatalog::V1::ImportTaxonomiesResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataCatalog::V1::ImportTaxonomiesResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb, line 274
def import_taxonomies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ImportTaxonomiesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.import_taxonomies.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.import_taxonomies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.import_taxonomies.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @policy_tag_manager_serialization_stub.call_rpc :import_taxonomies, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
replace_taxonomy(request, options = nil) { |response, operation| ... } click to toggle source

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages.

This operation automatically does the following:

  • Deletes the existing policy tags that are missing from the `SerializedPolicyTag`.

  • Creates policy tags that don't have resource names. They are considered new.

  • Updates policy tags with valid resources names accordingly.

@overload replace_taxonomy(request, options = nil)

Pass arguments to `replace_taxonomy` via a request object, either of type
{::Google::Cloud::DataCatalog::V1::ReplaceTaxonomyRequest} or an equivalent Hash.

@param request [::Google::Cloud::DataCatalog::V1::ReplaceTaxonomyRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload replace_taxonomy(name: nil, serialized_taxonomy: nil)

Pass arguments to `replace_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).

@param name [::String]
  Required. Resource name of the taxonomy to update.
@param serialized_taxonomy [::Google::Cloud::DataCatalog::V1::SerializedTaxonomy, ::Hash]
  Required. Taxonomy to update along with its child policy tags.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataCatalog::V1::Taxonomy] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataCatalog::V1::Taxonomy]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb, line 195
def replace_taxonomy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ReplaceTaxonomyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.replace_taxonomy.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.replace_taxonomy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.replace_taxonomy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @policy_tag_manager_serialization_stub.call_rpc :replace_taxonomy, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end