class Google::Cloud::ResourceManager::V3::TagBindings::Client
Client
for the TagBindings
service.
Allow users to create and manage TagBindings
between TagValues
and different cloud resources throughout the GCP resource hierarchy.
Attributes
Get the associated client for long-running operations.
@return [::Google::Cloud::ResourceManager::V3::TagBindings::Operations]
@private
Public Class Methods
Configure the TagBindings
Client
class.
See {::Google::Cloud::ResourceManager::V3::TagBindings::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all TagBindings clients ::Google::Cloud::ResourceManager::V3::TagBindings::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/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
Create a new TagBindings
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::ResourceManager::V3::TagBindings::Client.new # Create a client using a custom configuration client = ::Google::Cloud::ResourceManager::V3::TagBindings::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the TagBindings
client. @yieldparam config [Client::Configuration]
# 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
Public Instance Methods
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 {Client.configure}.
See {::Google::Cloud::ResourceManager::V3::TagBindings::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/resource_manager/v3/tag_bindings/client.rb, line 98 def configure yield @config if block_given? @config end
Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).
@overload create_tag_binding
(request, options = nil)
Pass arguments to `create_tag_binding` via a request object, either of type {::Google::Cloud::ResourceManager::V3::CreateTagBindingRequest} or an equivalent Hash. @param request [::Google::Cloud::ResourceManager::V3::CreateTagBindingRequest, ::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 create_tag_binding
(tag_binding: nil, validate_only: nil)
Pass arguments to `create_tag_binding` 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 tag_binding [::Google::Cloud::ResourceManager::V3::TagBinding, ::Hash] Required. The TagBinding to be created. @param validate_only [::Boolean] Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/resource_manager/v3/tag_bindings/client.rb, line 278 def create_tag_binding request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_tag_binding.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::ResourceManager::V3::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.create_tag_binding.timeout, metadata: metadata, retry_policy: @config.rpcs.create_tag_binding.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @tag_bindings_stub.call_rpc :create_tag_binding, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a TagBinding.
@overload delete_tag_binding
(request, options = nil)
Pass arguments to `delete_tag_binding` via a request object, either of type {::Google::Cloud::ResourceManager::V3::DeleteTagBindingRequest} or an equivalent Hash. @param request [::Google::Cloud::ResourceManager::V3::DeleteTagBindingRequest, ::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 delete_tag_binding
(name: nil)
Pass arguments to `delete_tag_binding` 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. The name of the TagBinding. This is a String of the form: `tagBindings/{id}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/resource_manager/v3/tag_bindings/client.rb, line 343 def delete_tag_binding request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_tag_binding.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::ResourceManager::V3::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.delete_tag_binding.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_tag_binding.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @tag_bindings_stub.call_rpc :delete_tag_binding, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists the TagBindings
for the given cloud resource, as specified with `parent`.
NOTE: The `parent` field is expected to be a full resource name: cloud.google.com/apis/design/resource_names#full_resource_name
@overload list_tag_bindings
(request, options = nil)
Pass arguments to `list_tag_bindings` via a request object, either of type {::Google::Cloud::ResourceManager::V3::ListTagBindingsRequest} or an equivalent Hash. @param request [::Google::Cloud::ResourceManager::V3::ListTagBindingsRequest, ::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 list_tag_bindings
(parent: nil, page_size: nil, page_token: nil)
Pass arguments to `list_tag_bindings` 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. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123" @param page_size [::Integer] Optional. The maximum number of TagBindings to return in the response. The server allows a maximum of 300 TagBindings to return. If unspecified, the server will use 100 as the default. @param page_token [::String] Optional. A pagination token returned from a previous call to `ListTagBindings` that indicates where this listing should continue from.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::TagBinding>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::TagBinding>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/resource_manager/v3/tag_bindings/client.rb, line 211 def list_tag_bindings request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_tag_bindings.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::ResourceManager::V3::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_tag_bindings.timeout, metadata: metadata, retry_policy: @config.rpcs.list_tag_bindings.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @tag_bindings_stub.call_rpc :list_tag_bindings, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @tag_bindings_stub, :list_tag_bindings, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end