google-apis-policysimulator_v1alpha 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a307c344c1887fc968b7d827130fe1f0220a801236f2203dde312316583b038
-  data.tar.gz: 9b4cb8e5a2c86562b43bee93fe7b75bc19d14a99fb78b3e08260a5bbc67f0fea
+  metadata.gz: cc052c7a83eb88c2adcab53ff8672c5afe8da2f250d4fc7543ed79a4eb2b253b
+  data.tar.gz: 6dc6ccc03fad72698bf06372f18574d8a03405b5ad29cfa34dc5cbccabb7113c
 SHA512:
-  metadata.gz: ed246aadc03804b3913149f280900fe58f868b02e5e6c5683ecc069c79e504b8ee13d3f9603934c5796d34161215b9d2c589aa545c8c481572b57bc9c72a96b2
-  data.tar.gz: 65715e43d2e16439e0cd0675424b51262005ca0bec18637a7cafeb47579edb99bd2635cd13106a0e7f24a50bd3aaec093d20c23731800fbeb7069a421b29e604
+  metadata.gz: 794a0e58dcade56bb45d5bfd0e905973492b83fcf9491f45c39e2f4cf24eb516fdcad4e7973228a556f4cb03c81a74a8c4093a3ab30ff261f1bd29702bbc150c
+  data.tar.gz: 349a6cc1e739aef53cfc468f552e71274ec993aaf9f57b5bad5eb64bb7957d53998b1591c62fcd6385c231a09d4a17abfbfe4e01834386e6fd2ba9199f8ebef9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-policysimulator_v1alpha
 
+### v0.17.0 (2024-01-28)
+
+* Regenerated from discovery document revision 20240121
+* Regenerated using generator version 0.13.1
+
 ### v0.16.0 (2024-01-22)
 
 * Regenerated using generator version 0.13.0

data/lib/google/apis/policysimulator_v1alpha/classes.rb

@@ -990,20 +990,21 @@ module Google
       class GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay
         include Google::Apis::Core::Hashable
       
-        # The OrgPolicy CustomConstraint changes to preview violations for. Any existing
-        # CustomConstraints with the same name will be overridden in the simulation.
-        # That is, violations will be determined as if all custom constraints in the
-        # overlay were instantiated. Only a single custom_constraint is supported in the
-        # overlay at a time. For evaluating multiple constraints, multiple `
-        # GenerateOrgPolicyViolationsPreview` requests are made, where each request
-        # evaluates a single constraint.
+        # Optional. The OrgPolicy CustomConstraint changes to preview violations for.
+        # Any existing CustomConstraints with the same name will be overridden in the
+        # simulation. That is, violations will be determined as if all custom
+        # constraints in the overlay were instantiated. Only a single custom_constraint
+        # is supported in the overlay at a time. For evaluating multiple constraints,
+        # multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each
+        # request evaluates a single constraint.
         # Corresponds to the JSON property `customConstraints`
         # @return [Array<Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay>]
         attr_accessor :custom_constraints
       
-        # The OrgPolicy changes to preview violations for. Any existing OrgPolicies with
-        # the same name will be overridden in the simulation. That is, violations will
-        # be determined as if all policies in the overlay were created or updated.
+        # Optional. The OrgPolicy changes to preview violations for. Any existing
+        # OrgPolicies with the same name will be overridden in the simulation. That is,
+        # violations will be determined as if all policies in the overlay were created
+        # or updated.
         # Corresponds to the JSON property `policies`
         # @return [Array<Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay>]
         attr_accessor :policies
@@ -1031,7 +1032,8 @@ module Google
         # @return [Google::Apis::PolicysimulatorV1alpha::GoogleCloudOrgpolicyV2CustomConstraint]
         attr_accessor :custom_constraint
       
-        # Resource the constraint is attached to. Example: "organization/987654"
+        # Optional. Resource the constraint is attached to. Example: "organization/
+        # 987654"
         # Corresponds to the JSON property `customConstraintParent`
         # @return [String]
         attr_accessor :custom_constraint_parent
@@ -1057,7 +1059,8 @@ module Google
         # @return [Google::Apis::PolicysimulatorV1alpha::GoogleCloudOrgpolicyV2Policy]
         attr_accessor :policy
       
-        # The parent of the policy we are attaching to. Example: "projects/123456"
+        # Optional. The parent of the policy we are attaching to. Example: "projects/
+        # 123456"
         # Corresponds to the JSON property `policyParent`
         # @return [String]
         attr_accessor :policy_parent
@@ -1202,29 +1205,29 @@ module Google
       class GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts
         include Google::Apis::Core::Hashable
       
-        # Number of scanned resources with zero violations.
+        # Output only. Number of scanned resources with zero violations.
         # Corresponds to the JSON property `compliant`
         # @return [Fixnum]
         attr_accessor :compliant
       
-        # Number of resources that returned an error when scanned.
+        # Output only. Number of resources that returned an error when scanned.
         # Corresponds to the JSON property `errors`
         # @return [Fixnum]
         attr_accessor :errors
       
-        # Number of scanned resources with at least one violation.
+        # Output only. Number of scanned resources with at least one violation.
         # Corresponds to the JSON property `noncompliant`
         # @return [Fixnum]
         attr_accessor :noncompliant
       
-        # Number of resources checked for compliance. Must equal: unenforced +
-        # noncompliant + compliant + error
+        # Output only. Number of resources checked for compliance. Must equal:
+        # unenforced + noncompliant + compliant + error
         # Corresponds to the JSON property `scanned`
         # @return [Fixnum]
         attr_accessor :scanned
       
-        # Number of resources where the constraint was not enforced, i.e. the Policy set
-        # `enforced: false` for that resource.
+        # Output only. Number of resources where the constraint was not enforced, i.e.
+        # the Policy set `enforced: false` for that resource.
         # Corresponds to the JSON property `unenforced`
         # @return [Fixnum]
         attr_accessor :unenforced
@@ -1573,20 +1576,21 @@ module Google
       class GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay
         include Google::Apis::Core::Hashable
       
-        # The OrgPolicy CustomConstraint changes to preview violations for. Any existing
-        # CustomConstraints with the same name will be overridden in the simulation.
-        # That is, violations will be determined as if all custom constraints in the
-        # overlay were instantiated. Only a single custom_constraint is supported in the
-        # overlay at a time. For evaluating multiple constraints, multiple `
-        # GenerateOrgPolicyViolationsPreview` requests are made, where each request
-        # evaluates a single constraint.
+        # Optional. The OrgPolicy CustomConstraint changes to preview violations for.
+        # Any existing CustomConstraints with the same name will be overridden in the
+        # simulation. That is, violations will be determined as if all custom
+        # constraints in the overlay were instantiated. Only a single custom_constraint
+        # is supported in the overlay at a time. For evaluating multiple constraints,
+        # multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each
+        # request evaluates a single constraint.
         # Corresponds to the JSON property `customConstraints`
         # @return [Array<Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay>]
         attr_accessor :custom_constraints
       
-        # The OrgPolicy changes to preview violations for. Any existing OrgPolicies with
-        # the same name will be overridden in the simulation. That is, violations will
-        # be determined as if all policies in the overlay were created or updated.
+        # Optional. The OrgPolicy changes to preview violations for. Any existing
+        # OrgPolicies with the same name will be overridden in the simulation. That is,
+        # violations will be determined as if all policies in the overlay were created
+        # or updated.
         # Corresponds to the JSON property `policies`
         # @return [Array<Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay>]
         attr_accessor :policies
@@ -1614,7 +1618,8 @@ module Google
         # @return [Google::Apis::PolicysimulatorV1alpha::GoogleCloudOrgpolicyV2CustomConstraint]
         attr_accessor :custom_constraint
       
-        # Resource the constraint is attached to. Example: "organization/987654"
+        # Optional. Resource the constraint is attached to. Example: "organization/
+        # 987654"
         # Corresponds to the JSON property `customConstraintParent`
         # @return [String]
         attr_accessor :custom_constraint_parent
@@ -1640,7 +1645,8 @@ module Google
         # @return [Google::Apis::PolicysimulatorV1alpha::GoogleCloudOrgpolicyV2Policy]
         attr_accessor :policy
       
-        # The parent of the policy we are attaching to. Example: "projects/123456"
+        # Optional. The parent of the policy we are attaching to. Example: "projects/
+        # 123456"
         # Corresponds to the JSON property `policyParent`
         # @return [String]
         attr_accessor :policy_parent
@@ -1736,29 +1742,29 @@ module Google
       class GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts
         include Google::Apis::Core::Hashable
       
-        # Number of scanned resources with zero violations.
+        # Output only. Number of scanned resources with zero violations.
         # Corresponds to the JSON property `compliant`
         # @return [Fixnum]
         attr_accessor :compliant
       
-        # Number of resources that returned an error when scanned.
+        # Output only. Number of resources that returned an error when scanned.
         # Corresponds to the JSON property `errors`
         # @return [Fixnum]
         attr_accessor :errors
       
-        # Number of scanned resources with at least one violation.
+        # Output only. Number of scanned resources with at least one violation.
         # Corresponds to the JSON property `noncompliant`
         # @return [Fixnum]
         attr_accessor :noncompliant
       
-        # Number of resources checked for compliance. Must equal: unenforced +
-        # noncompliant + compliant + error
+        # Output only. Number of resources checked for compliance. Must equal:
+        # unenforced + noncompliant + compliant + error
         # Corresponds to the JSON property `scanned`
         # @return [Fixnum]
         attr_accessor :scanned
       
-        # Number of resources where the constraint was not enforced, i.e. the Policy set
-        # `enforced: false` for that resource.
+        # Output only. Number of resources where the constraint was not enforced, i.e.
+        # the Policy set `enforced: false` for that resource.
         # Corresponds to the JSON property `unenforced`
         # @return [Fixnum]
         attr_accessor :unenforced
@@ -1929,7 +1935,10 @@ module Google
         attr_accessor :members
       
         # Role that is assigned to the list of `members`, or principals. For example, `
-        # roles/viewer`, `roles/editor`, or `roles/owner`.
+        # roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM
+        # roles and permissions, see the [IAM documentation](https://cloud.google.com/
+        # iam/docs/roles-overview). For a list of the available pre-defined roles, see [
+        # here](https://cloud.google.com/iam/docs/understanding-roles).
         # Corresponds to the JSON property `role`
         # @return [String]
         attr_accessor :role

data/lib/google/apis/policysimulator_v1alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module PolicysimulatorV1alpha
       # Version of the google-apis-policysimulator_v1alpha gem
-      GEM_VERSION = "0.16.0"
+      GEM_VERSION = "0.17.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.13.0"
+      GENERATOR_VERSION = "0.13.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231217"
+      REVISION = "20240121"
     end
   end
 end

data/lib/google/apis/policysimulator_v1alpha/service.rb

@@ -427,6 +427,44 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # GenerateOrgPolicyViolationsPreview generates an OrgPolicyViolationsPreview for
+        # the proposed changes in the provided OrgPolicyViolationsPreview.
+        # OrgPolicyOverlay. The changes to OrgPolicy are specified by this `
+        # OrgPolicyOverlay`. The resources to scan are inferred from these specified
+        # changes.
+        # @param [String] parent
+        #   Required. The organization under which this OrgPolicyViolationsPreview will be
+        #   created. Example: `organizations/my-example-org/locations/global`
+        # @param [Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview] google_cloud_policysimulator_v1alpha_org_policy_violations_preview_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::PolicysimulatorV1alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PolicysimulatorV1alpha::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def generate_organization_location_org_policy_violations_preview(parent, google_cloud_policysimulator_v1alpha_org_policy_violations_preview_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+parent}/orgPolicyViolationsPreviews:generate', options)
+          command.request_representation = Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview::Representation
+          command.request_object = google_cloud_policysimulator_v1alpha_org_policy_violations_preview_object
+          command.response_representation = Google::Apis::PolicysimulatorV1alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::PolicysimulatorV1alpha::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview.
         # Each OrgPolicyViolationsPreview is available for at least 7 days.
         # @param [String] name
@@ -465,13 +503,13 @@ module Google
         #   organization`/locations/`location`` Example: `organizations/my-example-org/
         #   locations/global`
         # @param [Fixnum] page_size
-        #   The maximum number of items to return. The service may return fewer than this
-        #   value. If unspecified, at most 5 items will be returned. The maximum value is
-        #   10; values above 10 will be coerced to 10.
+        #   Optional. The maximum number of items to return. The service may return fewer
+        #   than this value. If unspecified, at most 5 items will be returned. The maximum
+        #   value is 10; values above 10 will be coerced to 10.
         # @param [String] page_token
-        #   A page token, received from a previous call. Provide this to retrieve the
-        #   subsequent page. When paginating, all other parameters must match the call
-        #   that provided the page token.
+        #   Optional. A page token, received from a previous call. Provide this to
+        #   retrieve the subsequent page. When paginating, all other parameters must match
+        #   the call that provided the page token.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -539,13 +577,13 @@ module Google
         #   Format: organizations/`organization`/locations/`location`/
         #   orgPolicyViolationsPreviews/`orgPolicyViolationsPreview`
         # @param [Fixnum] page_size
-        #   The maximum number of items to return. The service may return fewer than this
-        #   value. If unspecified, at most 50 items will be returned. The maximum value is
-        #   1000; values above 1000 will be coerced to 1000.
+        #   Optional. The maximum number of items to return. The service may return fewer
+        #   than this value. If unspecified, at most 50 items will be returned. The
+        #   maximum value is 1000; values above 1000 will be coerced to 1000.
         # @param [String] page_token
-        #   A page token, received from a previous call. Provide this to retrieve the
-        #   subsequent page. When paginating, all other parameters must match the call
-        #   that provided the page token.
+        #   Optional. A page token, received from a previous call. Provide this to
+        #   retrieve the subsequent page. When paginating, all other parameters must match
+        #   the call that provided the page token.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-policysimulator_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-policysimulator_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-policysimulator_v1alpha/v0.16.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-policysimulator_v1alpha/v0.17.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-policysimulator_v1alpha
 post_install_message: 
 rdoc_options: []