Class: Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb

Overview

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.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path, #taxonomy_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new PolicyTagManagerSerialization REST client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the PolicyTagManagerSerialization client.

Yield Parameters:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb', line 127

def initialize
  # 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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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 = ::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @policy_tag_manager_serialization_stub.endpoint
    config.universe_domain = @policy_tag_manager_serialization_stub.universe_domain
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

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

Returns:

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


170
171
172
 
# File 'lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb', line 170

def iam_policy_client
  @iam_policy_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the PolicyTagManagerSerialization Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DataCatalog", "V1beta1"]
    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

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



97
98
99
100
 
# File 'lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb', line 97

def configure
  yield @config if block_given?
  @config
end

#export_taxonomies(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1beta1::ExportTaxonomiesResponse #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      Required. Resource name of the project that taxonomies to be exported will share.

    • taxonomies (::Array<::String>) (defaults to: nil) —

      Required. Resource names of the taxonomies to be exported.

    • serialized_taxonomies (::Boolean) (defaults to: nil) —

      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.



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb', line 310

def export_taxonomies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1beta1::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
  call_metadata = @config.rpcs.export_taxonomies.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1beta1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.export_taxonomies.timeout,
                         metadata:     call_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.export_taxonomies request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#import_taxonomies(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1beta1::ImportTaxonomiesResponse #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.

Examples:

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb', line 224

def import_taxonomies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1beta1::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
  call_metadata = @config.rpcs.import_taxonomies.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1beta1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.import_taxonomies.timeout,
                         metadata:     call_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.import_taxonomies request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


107
108
109
 
# File 'lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb', line 107

def universe_domain
  @policy_tag_manager_serialization_stub.universe_domain
end