google-iam-v2 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caffb30edb338bc16c74af9ca7131bd5cc4c5dc6d3b804d38a493c03324eccd0
-  data.tar.gz: 52bc25b5b0673b6e67d432daa92ae7934035195713088e705135fff2c16b7e99
+  metadata.gz: 248f01be8988d929513f8f65649eec51ad0b1bf2f0c1ac01b22c0fba699bcb99
+  data.tar.gz: c8f5fc37fbad07720f0c346817d91c3bdb13102a61a59ce8e646e5c2b8fb1bc7
 SHA512:
-  metadata.gz: a6e19a046fd40f46bbbd57a2858714c0bd7f433fcbc5bcb2368d503789cd526e3a06bb850140df5ce344573805b299e8bd77c9fd9a378a4e9514f6ed6feab946
-  data.tar.gz: 15e80e217a7887ffaaaca60b25b9b727c6ed97966a1d25b58e6afc0ea891b9fbee41d5b665c696871d476a97706256d95d35ee0e9f8c5a1fcd8a045db90b644a
+  metadata.gz: d5ec858cfbab3a6f4cee3503b5dab026dfe79686153fdf1de62f1eeb7dd4236e2f8355f40af5f95c8c16f6c937ff5b1ad99d5d4ca7c5b3d10b888507ad9440fb
+  data.tar.gz: b467614d3f14d083937af9edbe22759f847952c38c6e8d2593e9d30d5576cfb45fb26e5fc227aab736d0cea511abb0e0577de61a623befc60d47fe301d3365ea

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the IAM V2 API
 
-API Client library for the IAM V2 API
+Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.
 
 Manages identity and access control policies for Google Cloud Platform resources.
 
@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

data/lib/google/iam/v2/policies/client.rb

@@ -202,8 +202,9 @@ module Google
           #   the default parameter values, pass an empty Hash as a request object (see above).
           #
           #   @param parent [::String]
-          #     Required. The resource that the policy is attached to, along with the kind
-          #     of policy to list. Format: `policies/{attachment_point}/denypolicies`
+          #     Required. The resource that the policy is attached to, along with the kind of policy
+          #     to list. Format:
+          #     `policies/{attachment_point}/denypolicies`
           #
           #
           #     The attachment point is identified by its URL-encoded full resource name,
@@ -217,9 +218,8 @@ module Google
           #     The maximum number of policies to return. IAM ignores this value and uses
           #     the value 1000.
           #   @param page_token [::String]
-          #     A page token received in a
-          #     {::Google::Iam::V2::ListPoliciesResponse ListPoliciesResponse}. Provide this
-          #     token to retrieve the next page.
+          #     A page token received in a {::Google::Iam::V2::ListPoliciesResponse ListPoliciesResponse}. Provide this token to
+          #     retrieve the next page.
           #
           # @yield [response, operation] Access the result along with the RPC operation
           # @yieldparam response [::Gapic::PagedEnumerable<::Google::Iam::V2::Policy>]
@@ -241,13 +241,11 @@ module Google
           #   # Call the list_policies method.
           #   result = client.list_policies 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::Iam::V2::Policy.
-          #     p response
+          #     p item
           #   end
           #
           def list_policies request, options = nil
@@ -405,8 +403,8 @@ module Google
           #   the default parameter values, pass an empty Hash as a request object (see above).
           #
           #   @param parent [::String]
-          #     Required. The resource that the policy is attached to, along with the kind
-          #     of policy to create. Format: `policies/{attachment_point}/denypolicies`
+          #     Required. The resource that the policy is attached to, along with the kind of policy
+          #     to create. Format: `policies/{attachment_point}/denypolicies`
           #
           #
           #     The attachment point is identified by its URL-encoded full resource name,
@@ -444,14 +442,14 @@ module Google
           #   # Call the create_policy method.
           #   result = client.create_policy 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_policy request, options = nil
@@ -503,8 +501,7 @@ module Google
           #
           # To update a policy, you should use a read-modify-write loop:
           #
-          # 1. Use {::Google::Iam::V2::Policies::Client#get_policy GetPolicy} to read the current
-          # version of the policy.
+          # 1. Use {::Google::Iam::V2::Policies::Client#get_policy GetPolicy} to read the current version of the policy.
           # 2. Modify the policy as needed.
           # 3. Use `UpdatePolicy` to write the updated policy.
           #
@@ -552,14 +549,14 @@ module Google
           #   # Call the update_policy method.
           #   result = client.update_policy 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 update_policy request, options = nil
@@ -634,9 +631,9 @@ module Google
           #     For organizations and folders, use the numeric ID in the full resource
           #     name. For projects, you can use the alphanumeric or the numeric ID.
           #   @param etag [::String]
-          #     Optional. The expected `etag` of the policy to delete. If the value does
-          #     not match the value that is stored in IAM, the request fails with a `409`
-          #     error code and `ABORTED` status.
+          #     Optional. The expected `etag` of the policy to delete. If the value does not match
+          #     the value that is stored in IAM, the request fails with a `409` error code
+          #     and `ABORTED` status.
           #
           #     If you omit this field, the policy is deleted regardless of its current
           #     `etag`.
@@ -661,14 +658,14 @@ module Google
           #   # Call the delete_policy method.
           #   result = client.delete_policy 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_policy request, options = nil
@@ -713,130 +710,6 @@ module Google
             raise ::Google::Cloud::Error.from_error(e)
           end
 
-          ##
-          # Retrieves all the policies that are attached to the specified resource,
-          # or anywhere in the ancestry of the resource. For example, for a project
-          # this endpoint would return all the `denyPolicy` kind policies attached to
-          # the project, its parent folder (if any), and its parent organization (if
-          # any).
-          # The endpoint requires the same permissions that it would take to call
-          # `ListPolicies` or `GetPolicy`.
-          #
-          # The main reason to use this endpoint is as a policy admin to debug access
-          # issues for a resource.
-          #
-          # @overload list_applicable_policies(request, options = nil)
-          #   Pass arguments to `list_applicable_policies` via a request object, either of type
-          #   {::Google::Iam::V2::ListApplicablePoliciesRequest} or an equivalent Hash.
-          #
-          #   @param request [::Google::Iam::V2::ListApplicablePoliciesRequest, ::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_applicable_policies(attachment_point: nil, filter: nil, page_token: nil, page_size: nil)
-          #   Pass arguments to `list_applicable_policies` 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 attachment_point [::String]
-          #     Required. The Cloud resource at which the applicable policies are to be
-          #     retrieved. Format: `{attachment-point}` Use the URL-encoded full resource
-          #     name, which means that the forward-slash character, `/`, must be written as
-          #     `%2F`. For example,
-          #     `cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project`.
-          #   @param filter [::String]
-          #     Filtering currently only supports the kind of policies to return, and
-          #     must be in the format “kind:[policyKind1] OR kind:[policyKind2]”.  New
-          #     policy kinds may be added in the future without notice.
-          #
-          #     Example value: “kind:denyPolicies”
-          #   @param page_token [::String]
-          #     If present, then retrieve the batch of results following the results from
-          #     the preceding call to this method.  `page_token` must be the value of
-          #     `next_page_token`
-          #     {::Google::Iam::V2::ListApplicablePoliciesResponse#next_page_token ListApplicablePoliciesResponse.next_page_token}
-          #     from the previous response.  The values of other method parameters should
-          #     be identical to those in the previous call.
-          #   @param page_size [::Integer]
-          #     Limit on the number of policies to include in the response.
-          #     Further policies can subsequently be obtained by including the
-          #     [ListApplicablePoliciesResponse.next_page_token][google.iam.admin.v1.ListApplicablePoliciesResponse.next_page_token]
-          #     in a subsequent request.
-          #     The minimum is 25, and the maximum is 100.
-          #
-          # @yield [response, operation] Access the result along with the RPC operation
-          # @yieldparam response [::Gapic::PagedEnumerable<::Google::Iam::V2::Policy>]
-          # @yieldparam operation [::GRPC::ActiveCall::Operation]
-          #
-          # @return [::Gapic::PagedEnumerable<::Google::Iam::V2::Policy>]
-          #
-          # @raise [::Google::Cloud::Error] if the RPC is aborted.
-          #
-          # @example Basic example
-          #   require "google/iam/v2"
-          #
-          #   # Create a client object. The client can be reused for multiple calls.
-          #   client = Google::Iam::V2::Policies::Client.new
-          #
-          #   # Create a request. To set request fields, pass in keyword arguments.
-          #   request = Google::Iam::V2::ListApplicablePoliciesRequest.new
-          #
-          #   # Call the list_applicable_policies method.
-          #   result = client.list_applicable_policies 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|
-          #     # Each element is of type ::Google::Iam::V2::Policy.
-          #     p response
-          #   end
-          #
-          def list_applicable_policies request, options = nil
-            raise ::ArgumentError, "request must be provided" if request.nil?
-
-            request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V2::ListApplicablePoliciesRequest
-
-            # 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_applicable_policies.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::Iam::V2::VERSION
-            metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
-
-            header_params = {}
-            if request.attachment_point
-              header_params["attachment_point"] = request.attachment_point
-            end
-
-            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.list_applicable_policies.timeout,
-                                   metadata:     metadata,
-                                   retry_policy: @config.rpcs.list_applicable_policies.retry_policy
-
-            options.apply_defaults timeout:      @config.timeout,
-                                   metadata:     @config.metadata,
-                                   retry_policy: @config.retry_policy
-
-            @policies_stub.call_rpc :list_applicable_policies, request, options: options do |response, operation|
-              response = ::Gapic::PagedEnumerable.new @policies_stub, :list_applicable_policies, 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 Policies API.
           #
@@ -997,11 +870,6 @@ module Google
               # @return [::Gapic::Config::Method]
               #
               attr_reader :delete_policy
-              ##
-              # RPC-specific configuration for `list_applicable_policies`
-              # @return [::Gapic::Config::Method]
-              #
-              attr_reader :list_applicable_policies
 
               # @private
               def initialize parent_rpcs = nil
@@ -1015,8 +883,6 @@ module Google
                 @update_policy = ::Gapic::Config::Method.new update_policy_config
                 delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy
                 @delete_policy = ::Gapic::Config::Method.new delete_policy_config
-                list_applicable_policies_config = parent_rpcs.list_applicable_policies if parent_rpcs.respond_to? :list_applicable_policies
-                @list_applicable_policies = ::Gapic::Config::Method.new list_applicable_policies_config
 
                 yield self if block_given?
               end

data/lib/google/iam/v2/policies/operations.rb

@@ -157,13 +157,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
@@ -252,14 +250,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
@@ -539,14 +537,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