Class: Google::Cloud::ResourceManager::V3::TagBindings::Client
- Inherits:
-
Object
- Object
- Google::Cloud::ResourceManager::V3::TagBindings::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/resource_manager/v3/tag_bindings/client.rb
Overview
Client for the TagBindings service.
Allow users to create and manage TagBindings between TagValues and different cloud resources throughout the GCP resource hierarchy.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Cloud::ResourceManager::V3::TagBindings::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the TagBindings Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the TagBindings Client instance.
-
#create_tag_binding(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).
-
#delete_tag_binding(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a TagBinding.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new TagBindings client object.
-
#list_tag_bindings(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::TagBinding>
Lists the TagBindings for the given cloud resource, as specified with
parent
.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new TagBindings client object.
119 120 121 122 123 124 125 126 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 |
# File 'lib/google/cloud/resource_manager/v3/tag_bindings/client.rb', line 119 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/resourcemanager/v3/tag_bindings_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 @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @tag_bindings_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::ResourceManager::V3::TagBindings::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::ResourceManager::V3::TagBindings::Operations (readonly)
Get the associated client for long-running operations.
165 166 167 |
# File 'lib/google/cloud/resource_manager/v3/tag_bindings/client.rb', line 165 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the TagBindings Client class.
See Configuration for a description of the configuration fields.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/google/cloud/resource_manager/v3/tag_bindings/client.rb', line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "ResourceManager", "V3"] 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.rpcs.list_tag_bindings.timeout = 60.0 default_config.rpcs.list_tag_bindings.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.create_tag_binding.timeout = 60.0 default_config.rpcs.delete_tag_binding.timeout = 60.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the TagBindings 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.
98 99 100 101 |
# File 'lib/google/cloud/resource_manager/v3/tag_bindings/client.rb', line 98 def configure yield @config if block_given? @config end |
#create_tag_binding(request, options = nil) ⇒ ::Gapic::Operation #create_tag_binding(tag_binding: nil, validate_only: nil) ⇒ ::Gapic::Operation
Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/google/cloud/resource_manager/v3/tag_bindings/client.rb', line 278 def create_tag_binding request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::CreateTagBindingRequest # 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.create_tag_binding..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::ResourceManager::V3::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_tag_binding.timeout, metadata: , retry_policy: @config.rpcs.create_tag_binding.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @tag_bindings_stub.call_rpc :create_tag_binding, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_tag_binding(request, options = nil) ⇒ ::Gapic::Operation #delete_tag_binding(name: nil) ⇒ ::Gapic::Operation
Deletes a TagBinding.
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/google/cloud/resource_manager/v3/tag_bindings/client.rb', line 343 def delete_tag_binding request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::DeleteTagBindingRequest # 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.delete_tag_binding..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::ResourceManager::V3::VERSION [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_tag_binding.timeout, metadata: , retry_policy: @config.rpcs.delete_tag_binding.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @tag_bindings_stub.call_rpc :delete_tag_binding, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_tag_bindings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::TagBinding> #list_tag_bindings(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::TagBinding>
Lists the TagBindings for the given cloud resource, as specified with
parent
.
NOTE: The parent
field is expected to be a full resource name:
https://cloud.google.com/apis/design/resource_names#full_resource_name
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/google/cloud/resource_manager/v3/tag_bindings/client.rb', line 211 def list_tag_bindings request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::ListTagBindingsRequest # 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.list_tag_bindings..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::ResourceManager::V3::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_tag_bindings.timeout, metadata: , retry_policy: @config.rpcs.list_tag_bindings.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @tag_bindings_stub.call_rpc :list_tag_bindings, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @tag_bindings_stub, :list_tag_bindings, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |