google-cloud-policy_troubleshooter-v1 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce1586e4e49956206301b12edfb6ce47495ec870bf98ccaeb8bece4f02a7c5d1
-  data.tar.gz: 0ceff45f9591534f9147921256120f2e4c0256875a502d5b8f46843b547ae80a
+  metadata.gz: 635964024337f90223fb9098ff747d9091765a5a8449b927d5717bc6a4b60c00
+  data.tar.gz: 5bbce2b7e7c250bb4a089e3dd42ae79fe4ad0c071a76607a4db0616d1d50afe1
 SHA512:
-  metadata.gz: 8300bb23ee4b575b9500f3df85cac448ecf459ceccbecbb4629bbf7aa3d95027edb770d2830046179349e19d3843a8d1cc16f609833a630c1cd5220600e39edb
-  data.tar.gz: f448b70e529f6c845b2619c3c7e7689846a970ee9b5c8984e84a29172a1c69592156e4fd554c9227a6f2effe2a9b2e03a15b9bd2a7485369ad2843bee85afaa7
+  metadata.gz: a1fa663c954462fdc934be908a5826f015c78b509c8760d1e804454d24b7a5cda6399aa3b3ba2c811a69a2366f11bdbb45ebffcb3edefe3135cbdeda585fb7e7
+  data.tar.gz: feab98043dc05e27d203bec4a91c9ef1d7d934313294fc76364dce8d1fbb87702efe3008eee6dfbc3fc79bec3fc4e387edd9b4550e88a9b43c081349fc26c44d

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-policy_troubleshooter-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Credentials}):
 
-1. `POLICY_TROUBLESHOOTER_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `POLICY_TROUBLESHOOTER_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `POLICY_TROUBLESHOOTER_CREDENTIALS` - Path to JSON file, or JSON contents
+* `POLICY_TROUBLESHOOTER_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/policy_troubleshooter/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/policy_troubleshooter/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new do |c
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/policy_troubleshooter/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/policy_troubleshooter/v1"
 
 client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new
-request = my_create_request
+request = ::Google::Cloud::PolicyTroubleshooter::V1::TroubleshootIamPolicyRequest.new # (request fields as keyword arguments...)
 response = client.troubleshoot_iam_policy request
 ```
 

data/lib/google/cloud/policy_troubleshooter/v1/iam_checker/client.rb

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all IamChecker clients:
-            #
-            #     ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all IamChecker clients
+            #   ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -67,10 +66,7 @@ module Google
 
                 default_config.timeout = 60.0
                 default_config.retry_policy = {
-                  initial_delay: 1.0,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [14, 2]
+                  initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
                 }
 
                 default_config.rpcs.troubleshoot_iam_policy.timeout = 60.0
@@ -104,19 +100,15 @@ module Google
             ##
             # Create a new IamChecker client object.
             #
-            # ## Examples
-            #
-            # To create a new IamChecker client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new
             #
-            # To create a new IamChecker client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the IamChecker client.
             # @yieldparam config [Client::Configuration]
@@ -136,14 +128,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -191,6 +182,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/policy_troubleshooter/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PolicyTroubleshooter::V1::TroubleshootIamPolicyRequest.new
+            #
+            #   # Call the troubleshoot_iam_policy method.
+            #   result = client.troubleshoot_iam_policy request
+            #
+            #   # The returned object is of type Google::Cloud::PolicyTroubleshooter::V1::TroubleshootIamPolicyResponse.
+            #   p result
+            #
             def troubleshoot_iam_policy request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -211,7 +217,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.troubleshoot_iam_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.troubleshoot_iam_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @iam_checker_stub.call_rpc :troubleshoot_iam_policy, request, options: options do |response, operation|
@@ -235,22 +243,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for troubleshoot_iam_policy
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.troubleshoot_iam_policy.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.troubleshoot_iam_policy.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # troubleshoot_iam_policy to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.troubleshoot_iam_policy.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.troubleshoot_iam_policy.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/policy_troubleshooter/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module PolicyTroubleshooter
       module V1
-        VERSION = "0.3.0"
+        VERSION = "0.3.4"
       end
     end
   end

data/lib/google/cloud/policytroubleshooter/v1/checker_pb.rb

@@ -1,11 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/policytroubleshooter/v1/checker.proto
 
-require 'google/protobuf'
-
 require 'google/cloud/policytroubleshooter/v1/explanations_pb'
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/policytroubleshooter/v1/checker.proto", :syntax => :proto3) do
     add_message "google.cloud.policytroubleshooter.v1.TroubleshootIamPolicyRequest" do

data/lib/google/cloud/policytroubleshooter/v1/checker_services_pb.rb

@@ -30,7 +30,7 @@ module Google
           # This service helps you troubleshoot access issues for Google Cloud resources.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/policytroubleshooter/v1/explanations_pb.rb

@@ -1,11 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/policytroubleshooter/v1/explanations.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/iam/v1/policy_pb'
 require 'google/type/expr_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/policytroubleshooter/v1/explanations.proto", :syntax => :proto3) do
     add_message "google.cloud.policytroubleshooter.v1.AccessTuple" do

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

data/proto_docs/google/type/expr.rb

@@ -19,30 +19,53 @@
 
 module Google
   module Type
-    # Represents an expression text. Example:
+    # Represents a textual expression in the Common Expression Language (CEL)
+    # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+    # are documented at https://github.com/google/cel-spec.
     #
-    #     title: "User account presence"
-    #     description: "Determines whether the request has a user account"
-    #     expression: "size(request.user) > 0"
+    # Example (Comparison):
+    #
+    #     title: "Summary size limit"
+    #     description: "Determines if a summary is less than 100 chars"
+    #     expression: "document.summary.size() < 100"
+    #
+    # Example (Equality):
+    #
+    #     title: "Requestor is owner"
+    #     description: "Determines if requestor is the document owner"
+    #     expression: "document.owner == request.auth.claims.email"
+    #
+    # Example (Logic):
+    #
+    #     title: "Public documents"
+    #     description: "Determine whether the document should be publicly visible"
+    #     expression: "document.type != 'private' && document.type != 'internal'"
+    #
+    # Example (Data Manipulation):
+    #
+    #     title: "Notification string"
+    #     description: "Create a notification string with a timestamp."
+    #     expression: "'New message received at ' + string(document.create_time)"
+    #
+    # The exact variables and functions that may be referenced within an expression
+    # are determined by the service that evaluates it. See the service
+    # documentation for additional information.
     # @!attribute [rw] expression
     #   @return [::String]
-    #     Textual representation of an expression in
-    #     Common Expression Language syntax.
-    #
-    #     The application context of the containing message determines which
-    #     well-known feature set of CEL is supported.
+    #     Textual representation of an expression in Common Expression Language
+    #     syntax.
     # @!attribute [rw] title
     #   @return [::String]
-    #     An optional title for the expression, i.e. a short string describing
+    #     Optional. Title for the expression, i.e. a short string describing
     #     its purpose. This can be used e.g. in UIs which allow to enter the
     #     expression.
     # @!attribute [rw] description
     #   @return [::String]
-    #     An optional description of the expression. This is a longer text which
+    #     Optional. Description of the expression. This is a longer text which
     #     describes the expression, e.g. when hovered over it in a UI.
     # @!attribute [rw] location
     #   @return [::String]
-    #     An optional string indicating the location of the expression for error
+    #     Optional. String indicating the location of the expression for error
     #     reporting, e.g. a file name and a position in the file.
     class Expr
       include ::Google::Protobuf::MessageExts

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-policy_troubleshooter-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -47,7 +53,7 @@ dependencies:
         version: 0.6.10
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +63,7 @@ dependencies:
         version: 0.6.10
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -222,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the IAM Policy Troubleshooter V1 API