google-cloud-policy_simulator 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea5e56e454535fd1e25dfa31a7f345c04399a09e1c7335560c97fbaeb7241203
-  data.tar.gz: 75bfca4e9c930de016f372b8f220d9ae8a531635fd11b370dfcf7334e329c993
+  metadata.gz: '048c7412a9c19eb2c378af1a453c47817fcfdcad7200becd7fbfcbd336f60728'
+  data.tar.gz: cf5f5f73fa1ea1a6005ac8c22f3bd096c5d0ab6050da03651ea9f16f2b1380c9
 SHA512:
-  metadata.gz: 20e1991e9a6d2926f01b563fec143fd12f5a1088eefc4950294e6456f8f31279dafcd803c1609afb054270bcf9be70e6bf58313dd0cb030bc0d4df3a78c1b74f
-  data.tar.gz: d033489fcd8ffc3c5f2d203787d5d166854f55973f7356322af2d28f83f22ce6b3b7be2a0f7d47ee1e437d6ee756cd3e353d3f8187a4991187bda2b156f3be69
+  metadata.gz: 518f563a3ca4f19c2fa2815b807b81d02807f4a37a4c672761e57b8351ee6805c609bb7491aa968df458d716f67125bdc899931b585226b7dff3ec80580529ea
+  data.tar.gz: 2b8b280707f5caad3f686a57577f52e29b6dd716423a048574857837d407e79ba87e524a4664164873fd45cb6ffade54c060915f7ea8061fff9bffe23e1ac4a0

data/AUTHENTICATION.md

@@ -56,7 +56,7 @@ To configure a credentials file for an individual client initialization:
 ```ruby
 require "google/cloud/policy_simulator"
 
-client = Google::Cloud::PolicySimulator.simulator do |config|
+client = Google::Cloud::PolicySimulator.org_policy_violations_preview_service do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 ```
@@ -70,7 +70,7 @@ Google::Cloud::PolicySimulator.configure do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 
-client = Google::Cloud::PolicySimulator.simulator
+client = Google::Cloud::PolicySimulator.org_policy_violations_preview_service
 ```
 
 ### Environment Variables
@@ -100,7 +100,7 @@ require "google/cloud/policy_simulator"
 
 ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
 
-client = Google::Cloud::PolicySimulator.simulator
+client = Google::Cloud::PolicySimulator.org_policy_violations_preview_service
 ```
 
 ### Local ADC file

data/lib/google/cloud/policy_simulator/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module PolicySimulator
-      VERSION = "1.2.1"
+      VERSION = "1.3.0"
     end
   end
 end

data/lib/google/cloud/policy_simulator.rb

@@ -45,6 +45,86 @@ end
 module Google
   module Cloud
     module PolicySimulator
+      ##
+      # Create a new client object for OrgPolicyViolationsPreviewService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::PolicySimulator::V1::OrgPolicyViolationsPreviewService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-policy_simulator-v1/latest/Google-Cloud-PolicySimulator-V1-OrgPolicyViolationsPreviewService-Client)
+      # for a gRPC client for version V1 of the API.
+      # However, you can specify a different API version by passing it in the
+      # `version` parameter. If the OrgPolicyViolationsPreviewService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      # You can also specify a different transport by passing `:rest` or `:grpc` in
+      # the `transport` parameter.
+      #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the OrgPolicyViolationsPreviewService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::PolicySimulator.org_policy_violations_preview_service_available?}.
+      #
+      # ## About OrgPolicyViolationsPreviewService
+      #
+      # Violations Preview API service for OrgPolicy.
+      #
+      # An
+      # OrgPolicyViolationsPreview
+      # is a preview of the violations that will exist as soon as a proposed
+      # OrgPolicy change is submitted. To create an
+      # OrgPolicyViolationsPreview,
+      # the API user specifies the changes they wish to make and requests the
+      # generation of a preview via [GenerateViolationsPreview][]. the OrgPolicy
+      # Simulator service then scans the API user's currently existing resources to
+      # determine these resources violate the newly set OrgPolicy.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [::Object] A client object for the specified version.
+      #
+      def self.org_policy_violations_preview_service version: :v1, transport: :grpc, &block
+        require "google/cloud/policy_simulator/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::PolicySimulator
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::PolicySimulator.const_get(package_name).const_get(:OrgPolicyViolationsPreviewService)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the OrgPolicyViolationsPreviewService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::PolicySimulator.org_policy_violations_preview_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the OrgPolicyViolationsPreviewService service,
+      # or if the versioned client gem needs an update to support the OrgPolicyViolationsPreviewService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.org_policy_violations_preview_service_available? version: :v1, transport: :grpc
+        require "google/cloud/policy_simulator/#{version.to_s.downcase}"
+        package_name = Google::Cloud::PolicySimulator
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::PolicySimulator.const_get package_name
+        return false unless service_module.const_defined? :OrgPolicyViolationsPreviewService
+        service_module = service_module.const_get :OrgPolicyViolationsPreviewService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for Simulator.
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-policy_simulator
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Google LLC
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Policy Simulator is a collection of endpoints for creating, running, and
   viewing a [Replay][google.cloud.policysimulator.v1.Replay]. A `Replay` is a type