google-cloud-resource_manager-v3 0.4.0 → 0.5.1

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>]
@@ -263,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
@@ -284,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]
@@ -446,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.
             #
@@ -484,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
@@ -596,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
@@ -605,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

@@ -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

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

@@ -30,7 +30,7 @@ module Google
             # REST 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
@@ -159,8 +159,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
@@ -181,16 +181,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 [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::TagBinding>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -235,8 +235,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
@@ -256,8 +255,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 [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -366,6 +365,79 @@ 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 [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::EffectiveTag>]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::EffectiveTag>]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              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
+                call_metadata = @config.rpcs.list_effective_tags.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                call_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,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_effective_tags.timeout,
+                                       metadata:     call_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.list_effective_tags request, options do |result, operation|
+                  result = ::Gapic::Rest::PagedEnumerable.new @tag_bindings_stub, :list_effective_tags, "effective_tags", request, result, options
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the TagBindings REST API.
               #
@@ -404,9 +476,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))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope
@@ -504,6 +576,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
@@ -513,6 +590,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/rest/operations.rb

@@ -411,9 +411,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))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope

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

@@ -154,6 +154,44 @@ module Google
                 result
               end
 
+              ##
+              # Baseline implementation for the list_effective_tags REST call
+              #
+              # @param request_pb [::Google::Cloud::ResourceManager::V3::ListEffectiveTagsRequest]
+              #   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::ListEffectiveTagsResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::ResourceManager::V3::ListEffectiveTagsResponse]
+              #   A result object deserialized from the server's reply
+              def list_effective_tags request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_list_effective_tags_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::ListEffectiveTagsResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
               ##
               # @private
               #
@@ -213,6 +251,25 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the list_effective_tags REST call
+              #
+              # @param request_pb [::Google::Cloud::ResourceManager::V3::ListEffectiveTagsRequest]
+              #   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_effective_tags_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v3/effectiveTags",
+                                                          matches: []
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

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

@@ -33,7 +33,7 @@ module Google
       module V3
         ##
         # 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.
         #
         # To load this service and instantiate a REST client:
         #

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

@@ -34,7 +34,7 @@ module Google
       module V3
         ##
         # 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.
         #
         # @example Load this service and instantiate a gRPC client
         #