google-cloud-resource_manager-v3 0.3.0 → 0.5.0

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

@@ -0,0 +1,53 @@
+# 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/projects/credentials"
+require "google/cloud/resource_manager/v3/projects/paths"
+require "google/cloud/resource_manager/v3/projects/rest/operations"
+require "google/cloud/resource_manager/v3/projects/rest/client"
+
+module Google
+  module Cloud
+    module ResourceManager
+      module V3
+        ##
+        # Manages Google Cloud Projects.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/resource_manager/v3/projects/rest"
+        #     client = ::Google::Cloud::ResourceManager::V3::Projects::Rest::Client.new
+        #
+        module Projects
+          # 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/projects/rest/helpers" if ::File.file? helper_path

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

@@ -26,6 +26,7 @@ require "google/cloud/resource_manager/v3/projects/credentials"
 require "google/cloud/resource_manager/v3/projects/paths"
 require "google/cloud/resource_manager/v3/projects/operations"
 require "google/cloud/resource_manager/v3/projects/client"
+require "google/cloud/resource_manager/v3/projects/rest"
 
 module Google
   module Cloud
@@ -34,11 +35,16 @@ module Google
         ##
         # Manages Google Cloud Projects.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/resource_manager/v3/projects"
         #     client = ::Google::Cloud::ResourceManager::V3::Projects::Client.new
         #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/resource_manager/v3/projects/rest"
+        #     client = ::Google::Cloud::ResourceManager::V3::Projects::Rest::Client.new
+        #
         module Projects
         end
       end

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

@@ -0,0 +1,43 @@
+# 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/resource_manager/v3/folders/rest"
+require "google/cloud/resource_manager/v3/organizations/rest"
+require "google/cloud/resource_manager/v3/projects/rest"
+require "google/cloud/resource_manager/v3/tag_bindings/rest"
+require "google/cloud/resource_manager/v3/tag_holds/rest"
+require "google/cloud/resource_manager/v3/tag_keys/rest"
+require "google/cloud/resource_manager/v3/tag_values/rest"
+require "google/cloud/resource_manager/v3/version"
+
+module Google
+  module Cloud
+    module ResourceManager
+      ##
+      # To load just the REST part of this package, including all its services, and instantiate a REST client:
+      #
+      # @example
+      #
+      #     require "google/cloud/resource_manager/v3/rest"
+      #     client = ::Google::Cloud::ResourceManager::V3::Folders::Rest::Client.new
+      #
+      module V3
+      end
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module Google
           # Client for the TagBindings service.
           #
           # Allow users to create and manage TagBindings between TagValues and
-          # different cloud resources throughout the GCP resource hierarchy.
+          # different Google Cloud resources throughout the GCP resource hierarchy.
           #
           class Client
             include Paths
@@ -168,8 +168,8 @@ module Google
             # Service calls
 
             ##
-            # Lists the TagBindings for the given cloud resource, as specified with
-            # `parent`.
+            # Lists the TagBindings for the given Google 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
@@ -190,16 +190,16 @@ module Google
             #   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"
+            #     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.
+            #     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.
+            #     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>]
@@ -221,13 +221,11 @@ module Google
             #   # Call the list_tag_bindings method.
             #   result = client.list_tag_bindings request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::ResourceManager::V3::TagBinding.
-            #     p response
+            #     p item
             #   end
             #
             def list_tag_bindings request, options = nil
@@ -265,8 +263,7 @@ module Google
             end
 
             ##
-            # Creates a TagBinding between a TagValue and a cloud resource
-            # (currently project, folder, or organization).
+            # Creates a TagBinding between a TagValue and a Google Cloud resource.
             #
             # @overload create_tag_binding(request, options = nil)
             #   Pass arguments to `create_tag_binding` via a request object, either of type
@@ -286,8 +283,8 @@ module Google
             #   @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.
+            #     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]
@@ -309,14 +306,14 @@ module Google
             #   # Call the create_tag_binding method.
             #   result = client.create_tag_binding request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def create_tag_binding request, options = nil
@@ -396,14 +393,14 @@ module Google
             #   # Call the delete_tag_binding method.
             #   result = client.delete_tag_binding request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def delete_tag_binding request, options = nil
@@ -448,6 +445,98 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Return a list of effective tags for the given Google Cloud resource, as
+            # specified in `parent`.
+            #
+            # @overload list_effective_tags(request, options = nil)
+            #   Pass arguments to `list_effective_tags` via a request object, either of type
+            #   {::Google::Cloud::ResourceManager::V3::ListEffectiveTagsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::ResourceManager::V3::ListEffectiveTagsRequest, ::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_effective_tags(parent: nil, page_size: nil, page_token: nil)
+            #   Pass arguments to `list_effective_tags` 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
+            #     the effective tags. E.g.
+            #     "//cloudresourcemanager.googleapis.com/projects/123"
+            #   @param page_size [::Integer]
+            #     Optional. The maximum number of effective tags to return in the response.
+            #     The server allows a maximum of 300 effective tags to return in a single
+            #     page. If unspecified, the server will use 100 as the default.
+            #   @param page_token [::String]
+            #     Optional. A pagination token returned from a previous call to
+            #     `ListEffectiveTags` that indicates from where this listing should continue.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::EffectiveTag>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::EffectiveTag>]
+            #
+            # @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::TagBindings::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ResourceManager::V3::ListEffectiveTagsRequest.new
+            #
+            #   # Call the list_effective_tags method.
+            #   result = client.list_effective_tags request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
+            #     # Each element is of type ::Google::Cloud::ResourceManager::V3::EffectiveTag.
+            #     p item
+            #   end
+            #
+            def list_effective_tags request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::ListEffectiveTagsRequest
+
+              # 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_effective_tags.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_effective_tags.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.list_effective_tags.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @tag_bindings_stub.call_rpc :list_effective_tags, request, options: options do |response, operation|
+                response = ::Gapic::PagedEnumerable.new @tag_bindings_stub, :list_effective_tags, 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
+
             ##
             # Configuration class for the TagBindings API.
             #
@@ -486,9 +575,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
@@ -598,6 +687,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :delete_tag_binding
+                ##
+                # RPC-specific configuration for `list_effective_tags`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :list_effective_tags
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -607,6 +701,8 @@ module Google
                   @create_tag_binding = ::Gapic::Config::Method.new create_tag_binding_config
                   delete_tag_binding_config = parent_rpcs.delete_tag_binding if parent_rpcs.respond_to? :delete_tag_binding
                   @delete_tag_binding = ::Gapic::Config::Method.new delete_tag_binding_config
+                  list_effective_tags_config = parent_rpcs.list_effective_tags if parent_rpcs.respond_to? :list_effective_tags
+                  @list_effective_tags = ::Gapic::Config::Method.new list_effective_tags_config
 
                   yield self if block_given?
                 end

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

@@ -158,13 +158,11 @@ module Google
             #   # Call the list_operations method.
             #   result = client.list_operations request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # Call the get_operation method.
             #   result = client.get_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # Call the wait_operation method.
             #   result = client.wait_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil
@@ -622,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