Class: Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb
Overview
REST 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.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client
readonly
Get the associated client for mix-in of the IAMPolicy.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the PolicyTagManagerSerialization Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the PolicyTagManagerSerialization Client instance.
-
#export_taxonomies(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::ExportTaxonomiesResponse
Exports taxonomies in the requested type and returns them, including their policy tags.
-
#import_taxonomies(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::ImportTaxonomiesResponse
Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new PolicyTagManagerSerialization REST client object.
-
#replace_taxonomy(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::Taxonomy
Replaces (updates) a taxonomy and all its policy tags.
-
#universe_domain ⇒ String
The effective universe domain.
Methods included from Paths
#location_path, #taxonomy_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new PolicyTagManagerSerialization REST client object.
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 164 165 |
# File 'lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb', line 129 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::V1::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.
172 173 174 |
# File 'lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb', line 172 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.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb', line 65 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 |
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.
99 100 101 102 |
# File 'lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb', line 99 def configure yield @config if block_given? @config end |
#export_taxonomies(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::ExportTaxonomiesResponse #export_taxonomies(parent: nil, taxonomies: nil, serialized_taxonomies: nil) ⇒ ::Google::Cloud::DataCatalog::V1::ExportTaxonomiesResponse
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.
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
# File 'lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb', line 412 def export_taxonomies request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.export_taxonomies..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.export_taxonomies.timeout, metadata: , retry_policy: @config.rpcs.export_taxonomies.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @policy_tag_manager_serialization_stub.export_taxonomies request, 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::V1::ImportTaxonomiesResponse #import_taxonomies(parent: nil, inline_source: nil, cross_regional_source: nil) ⇒ ::Google::Cloud::DataCatalog::V1::ImportTaxonomiesResponse
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.
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb', line 323 def import_taxonomies request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.import_taxonomies..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.import_taxonomies.timeout, metadata: , retry_policy: @config.rpcs.import_taxonomies.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @policy_tag_manager_serialization_stub.import_taxonomies request, 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 |
#replace_taxonomy(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Taxonomy #replace_taxonomy(name: nil, serialized_taxonomy: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Taxonomy
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.
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 258 259 260 261 262 263 264 265 266 |
# File 'lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb', line 233 def replace_taxonomy request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.replace_taxonomy..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.replace_taxonomy.timeout, metadata: , retry_policy: @config.rpcs.replace_taxonomy.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @policy_tag_manager_serialization_stub.replace_taxonomy request, 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
109 110 111 |
# File 'lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb', line 109 def universe_domain @policy_tag_manager_serialization_stub.universe_domain end |