google-cloud-resource_manager-v3 0.4.0 → 0.5.0

data/lib/google/cloud/resource_manager/v3/tag_holds/rest/service_stub.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/resourcemanager/v3/tag_holds_pb"
+
+module Google
+  module Cloud
+    module ResourceManager
+      module V3
+        module TagHolds
+          module Rest
+            ##
+            # REST service stub for the TagHolds service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              def initialize endpoint:, credentials:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                                                             numeric_enums: true,
+                                                             raise_faraday_errors: false
+              end
+
+              ##
+              # Baseline implementation for the create_tag_hold REST call
+              #
+              # @param request_pb [::Google::Cloud::ResourceManager::V3::CreateTagHoldRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def create_tag_hold request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_create_tag_hold_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the delete_tag_hold REST call
+              #
+              # @param request_pb [::Google::Cloud::ResourceManager::V3::DeleteTagHoldRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def delete_tag_hold request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_delete_tag_hold_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the list_tag_holds REST call
+              #
+              # @param request_pb [::Google::Cloud::ResourceManager::V3::ListTagHoldsRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::ResourceManager::V3::ListTagHoldsResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::ResourceManager::V3::ListTagHoldsResponse]
+              #   A result object deserialized from the server's reply
+              def list_tag_holds request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_list_tag_holds_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::ResourceManager::V3::ListTagHoldsResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the create_tag_hold REST call
+              #
+              # @param request_pb [::Google::Cloud::ResourceManager::V3::CreateTagHoldRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_create_tag_hold_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v3/{parent}/tagHolds",
+                                                          body: "tag_hold",
+                                                          matches: [
+                                                            ["parent", %r{^tagValues/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the delete_tag_hold REST call
+              #
+              # @param request_pb [::Google::Cloud::ResourceManager::V3::DeleteTagHoldRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_delete_tag_hold_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :delete,
+                                                          uri_template: "/v3/{name}",
+                                                          matches: [
+                                                            ["name", %r{^tagValues/[^/]+/tagHolds/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the list_tag_holds REST call
+              #
+              # @param request_pb [::Google::Cloud::ResourceManager::V3::ListTagHoldsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_list_tag_holds_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v3/{parent}/tagHolds",
+                                                          matches: [
+                                                            ["parent", %r{^tagValues/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/resource_manager/v3/tag_holds/rest.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/resource_manager/v3/version"
+
+require "google/cloud/resource_manager/v3/tag_holds/credentials"
+require "google/cloud/resource_manager/v3/tag_holds/paths"
+require "google/cloud/resource_manager/v3/tag_holds/rest/operations"
+require "google/cloud/resource_manager/v3/tag_holds/rest/client"
+
+module Google
+  module Cloud
+    module ResourceManager
+      module V3
+        ##
+        # Allow users to create and manage TagHolds for TagValues. TagHolds represent
+        # the use of a Tag Value that is not captured by TagBindings but
+        # should still block TagValue deletion (such as a reference in a policy
+        # condition). This service provides isolated failure domains by cloud location
+        # so that TagHolds can be managed in the same location as their usage.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/resource_manager/v3/tag_holds/rest"
+        #     client = ::Google::Cloud::ResourceManager::V3::TagHolds::Rest::Client.new
+        #
+        module TagHolds
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/resource_manager/v3/tag_holds/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/resource_manager/v3/tag_holds.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/resource_manager/v3/version"
+
+require "google/cloud/resource_manager/v3/tag_holds/credentials"
+require "google/cloud/resource_manager/v3/tag_holds/paths"
+require "google/cloud/resource_manager/v3/tag_holds/operations"
+require "google/cloud/resource_manager/v3/tag_holds/client"
+require "google/cloud/resource_manager/v3/tag_holds/rest"
+
+module Google
+  module Cloud
+    module ResourceManager
+      module V3
+        ##
+        # Allow users to create and manage TagHolds for TagValues. TagHolds represent
+        # the use of a Tag Value that is not captured by TagBindings but
+        # should still block TagValue deletion (such as a reference in a policy
+        # condition). This service provides isolated failure domains by cloud location
+        # so that TagHolds can be managed in the same location as their usage.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/resource_manager/v3/tag_holds"
+        #     client = ::Google::Cloud::ResourceManager::V3::TagHolds::Client.new
+        #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/resource_manager/v3/tag_holds/rest"
+        #     client = ::Google::Cloud::ResourceManager::V3::TagHolds::Rest::Client.new
+        #
+        module TagHolds
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "tag_holds", "helpers.rb"
+require "google/cloud/resource_manager/v3/tag_holds/helpers" if ::File.file? helper_path

data/lib/google/cloud/resource_manager/v3/tag_keys/client.rb

@@ -202,9 +202,9 @@ module Google
             #     Required. The resource name of the new TagKey's parent.
             #     Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
             #   @param page_size [::Integer]
-            #     Optional. The maximum number of TagKeys to return in the response. The server allows
-            #     a maximum of 300 TagKeys to return. If unspecified, the server will use 100
-            #     as the default.
+            #     Optional. The maximum number of TagKeys to return in the response. The
+            #     server allows a maximum of 300 TagKeys 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 `ListTagKey`
             #     that indicates where this listing should continue from.
@@ -357,11 +357,93 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Retrieves a TagKey by its namespaced name.
+            # This method will return `PERMISSION_DENIED` if the key does not exist
+            # or the user does not have permission to view it.
+            #
+            # @overload get_namespaced_tag_key(request, options = nil)
+            #   Pass arguments to `get_namespaced_tag_key` via a request object, either of type
+            #   {::Google::Cloud::ResourceManager::V3::GetNamespacedTagKeyRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::ResourceManager::V3::GetNamespacedTagKeyRequest, ::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 get_namespaced_tag_key(name: nil)
+            #   Pass arguments to `get_namespaced_tag_key` 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. A namespaced tag key name in the format
+            #     `{parentId}/{tagKeyShort}`, such as `42/foo` for a key with short name
+            #     "foo" under the organization with ID 42 or `r2-d2/bar` for a key with short
+            #     name "bar" under the project `r2-d2`.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::ResourceManager::V3::TagKey]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::ResourceManager::V3::TagKey]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/resource_manager/v3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ResourceManager::V3::TagKeys::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ResourceManager::V3::GetNamespacedTagKeyRequest.new
+            #
+            #   # Call the get_namespaced_tag_key method.
+            #   result = client.get_namespaced_tag_key request
+            #
+            #   # The returned object is of type Google::Cloud::ResourceManager::V3::TagKey.
+            #   p result
+            #
+            def get_namespaced_tag_key request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::GetNamespacedTagKeyRequest
+
+              # 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.get_namespaced_tag_key.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.get_namespaced_tag_key.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.get_namespaced_tag_key.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @tag_keys_stub.call_rpc :get_namespaced_tag_key, 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
+
             ##
             # Creates a new TagKey. If another request with the same parameters is
             # sent while the original request is in process, the second request
-            # will receive an error. A maximum of 300 TagKeys can exist under a parent at
-            # any given time.
+            # will receive an error. A maximum of 1000 TagKeys can exist under a parent
+            # at any given time.
             #
             # @overload create_tag_key(request, options = nil)
             #   Pass arguments to `create_tag_key` via a request object, either of type
@@ -379,11 +461,11 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param tag_key [::Google::Cloud::ResourceManager::V3::TagKey, ::Hash]
-            #     Required. The TagKey to be created. Only fields `short_name`, `description`,
-            #     and `parent` are considered during the creation request.
+            #     Required. The TagKey to be created. Only fields `short_name`,
+            #     `description`, and `parent` are considered during the creation request.
             #   @param validate_only [::Boolean]
-            #     Optional. Set to true to perform validations necessary for creating the resource, but
-            #     not actually perform the action.
+            #     Optional. Set to true to perform 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]
@@ -468,10 +550,10 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param tag_key [::Google::Cloud::ResourceManager::V3::TagKey, ::Hash]
-            #     Required. The new definition of the TagKey. Only the `description` and `etag` fields
-            #     can be updated by this request. If the `etag` field is not empty, it
-            #     must match the `etag` field of the existing tag key. Otherwise,
-            #     `FAILED_PRECONDITION` will be returned.
+            #     Required. The new definition of the TagKey. Only the `description` and
+            #     `etag` fields can be updated by this request. If the `etag` field is not
+            #     empty, it must match the `etag` field of the existing tag key. Otherwise,
+            #     `ABORTED` will be returned.
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Fields to be updated. The mask may only contain `description` or
             #     `etag`. If omitted entirely, both `description` and `etag` are assumed to
@@ -572,15 +654,15 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`.
-            #     The TagKey cannot be a parent of any existing TagValues or it will not be
-            #     deleted successfully.
+            #     Required. The resource name of a TagKey to be deleted in the format
+            #     `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or
+            #     it will not be deleted successfully.
             #   @param validate_only [::Boolean]
-            #     Optional. Set as true to perform validations necessary for deletion, but not actually
-            #     perform the action.
+            #     Optional. Set as true to perform validations necessary for deletion, but
+            #     not actually perform the action.
             #   @param etag [::String]
-            #     Optional. The etag known to the client for the expected state of the TagKey. This is
-            #     to be used for optimistic concurrency.
+            #     Optional. The etag known to the client for the expected state of the
+            #     TagKey. This is to be used for optimistic concurrency.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -982,9 +1064,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
@@ -1090,6 +1172,11 @@ module Google
                 #
                 attr_reader :get_tag_key
                 ##
+                # RPC-specific configuration for `get_namespaced_tag_key`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :get_namespaced_tag_key
+                ##
                 # RPC-specific configuration for `create_tag_key`
                 # @return [::Gapic::Config::Method]
                 #
@@ -1126,6 +1213,8 @@ module Google
                   @list_tag_keys = ::Gapic::Config::Method.new list_tag_keys_config
                   get_tag_key_config = parent_rpcs.get_tag_key if parent_rpcs.respond_to? :get_tag_key
                   @get_tag_key = ::Gapic::Config::Method.new get_tag_key_config
+                  get_namespaced_tag_key_config = parent_rpcs.get_namespaced_tag_key if parent_rpcs.respond_to? :get_namespaced_tag_key
+                  @get_namespaced_tag_key = ::Gapic::Config::Method.new get_namespaced_tag_key_config
                   create_tag_key_config = parent_rpcs.create_tag_key if parent_rpcs.respond_to? :create_tag_key
                   @create_tag_key = ::Gapic::Config::Method.new create_tag_key_config
                   update_tag_key_config = parent_rpcs.update_tag_key if parent_rpcs.respond_to? :update_tag_key

data/lib/google/cloud/resource_manager/v3/tag_keys/operations.rb

@@ -620,9 +620,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials