From 499a27dfb99a9436944fa31e942e2239791f2839 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Fri, 2 Feb 2024 01:30:43 +0000 Subject: [PATCH] feat(policysimulator): update the API #### policysimulator:v1alpha The following keys were added: - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.flatPath - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.httpMethod - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.id - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameterOrder - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.location - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.pattern - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.required - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.type - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.path - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.request.$ref - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.response.$ref - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.scopes - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.errors.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.errors.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.readOnly The following keys were changed: - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.resources.orgPolicyViolations.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.resources.orgPolicyViolations.methods.list.parameters.pageToken.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay.properties.customConstraints.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay.properties.policies.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraint.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraintParent.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay.properties.policy.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay.properties.policyParent.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.errors.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay.properties.customConstraints.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay.properties.policies.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraint.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraintParent.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay.properties.policy.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay.properties.policyParent.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.errors.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.description - schemas.GoogleIamV1Binding.properties.role.description #### policysimulator:v1beta The following keys were added: - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.flatPath - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.httpMethod - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.id - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameterOrder - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.location - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.pattern - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.required - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.parameters.parent.type - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.path - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.request.$ref - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.response.$ref - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.generate.scopes - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.errors.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.errors.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.readOnly The following keys were changed: - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.resources.orgPolicyViolations.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.resources.orgPolicyViolations.methods.list.parameters.pageToken.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay.properties.customConstraints.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay.properties.policies.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraint.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraintParent.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay.properties.policy.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay.properties.policyParent.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.errors.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay.properties.customConstraints.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay.properties.policies.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraint.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraintParent.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay.properties.policy.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay.properties.policyParent.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.errors.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.description - schemas.GoogleIamV1Binding.properties.role.description #### policysimulator:v1 The following keys were added: - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.errors.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.readOnly - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.errors.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.readOnly - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.readOnly The following keys were changed: - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay.properties.customConstraints.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay.properties.policies.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraint.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraintParent.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay.properties.policy.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay.properties.policyParent.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.errors.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.description - schemas.GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay.properties.customConstraints.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay.properties.policies.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraint.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay.properties.customConstraintParent.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay.properties.policy.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay.properties.policyParent.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.compliant.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.errors.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.noncompliant.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.scanned.description - schemas.GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts.properties.unenforced.description - schemas.GoogleIamV1Binding.properties.role.description --- discovery/policysimulator-v1.json | 58 +++++++++------- discovery/policysimulator-v1alpha.json | 94 ++++++++++++++++++-------- discovery/policysimulator-v1beta.json | 94 ++++++++++++++++++-------- src/apis/policysimulator/v1.ts | 46 ++++++------- 4 files changed, 189 insertions(+), 103 deletions(-) diff --git a/discovery/policysimulator-v1.json b/discovery/policysimulator-v1.json index ce895ce50d..fdecc4745b 100644 --- a/discovery/policysimulator-v1.json +++ b/discovery/policysimulator-v1.json @@ -707,7 +707,7 @@ } } }, - "revision": "20231217", + "revision": "20240128", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1402,14 +1402,14 @@ "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", "properties": { "customConstraints": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay" }, "type": "array" }, "policies": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay" }, @@ -1424,10 +1424,10 @@ "properties": { "customConstraint": { "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "The new or updated custom constraint." + "description": "Optional. The new or updated custom constraint." }, "customConstraintParent": { - "description": "Resource the constraint is attached to. Example: \"organization/987654\"", + "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", "type": "string" } }, @@ -1439,10 +1439,10 @@ "properties": { "policy": { "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "The new or updated OrgPolicy." + "description": "Optional. The new or updated OrgPolicy." }, "policyParent": { - "description": "The parent of the policy we are attaching to. Example: \"projects/123456\"", + "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", "type": "string" } }, @@ -1513,28 +1513,33 @@ "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", "properties": { "compliant": { - "description": "Number of scanned resources with zero violations.", + "description": "Output only. Number of scanned resources with zero violations.", "format": "int32", + "readOnly": true, "type": "integer" }, "errors": { - "description": "Number of resources that returned an error when scanned.", + "description": "Output only. Number of resources that returned an error when scanned.", "format": "int32", + "readOnly": true, "type": "integer" }, "noncompliant": { - "description": "Number of scanned resources with at least one violation.", + "description": "Output only. Number of scanned resources with at least one violation.", "format": "int32", + "readOnly": true, "type": "integer" }, "scanned": { - "description": "Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", + "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", "format": "int32", + "readOnly": true, "type": "integer" }, "unenforced": { - "description": "Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", + "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", "format": "int32", + "readOnly": true, "type": "integer" } }, @@ -1595,14 +1600,14 @@ "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", "properties": { "customConstraints": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay" }, "type": "array" }, "policies": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay" }, @@ -1617,10 +1622,10 @@ "properties": { "customConstraint": { "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "The new or updated custom constraint." + "description": "Optional. The new or updated custom constraint." }, "customConstraintParent": { - "description": "Resource the constraint is attached to. Example: \"organization/987654\"", + "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", "type": "string" } }, @@ -1632,10 +1637,10 @@ "properties": { "policy": { "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "The new or updated OrgPolicy." + "description": "Optional. The new or updated OrgPolicy." }, "policyParent": { - "description": "The parent of the policy we are attaching to. Example: \"projects/123456\"", + "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", "type": "string" } }, @@ -1706,28 +1711,33 @@ "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", "properties": { "compliant": { - "description": "Number of scanned resources with zero violations.", + "description": "Output only. Number of scanned resources with zero violations.", "format": "int32", + "readOnly": true, "type": "integer" }, "errors": { - "description": "Number of resources that returned an error when scanned.", + "description": "Output only. Number of resources that returned an error when scanned.", "format": "int32", + "readOnly": true, "type": "integer" }, "noncompliant": { - "description": "Number of scanned resources with at least one violation.", + "description": "Output only. Number of scanned resources with at least one violation.", "format": "int32", + "readOnly": true, "type": "integer" }, "scanned": { - "description": "Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", + "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", "format": "int32", + "readOnly": true, "type": "integer" }, "unenforced": { - "description": "Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", + "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", "format": "int32", + "readOnly": true, "type": "integer" } }, @@ -1797,7 +1807,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "description": "Role that is assigned to the list of `members`, or principals. For example, `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).", "type": "string" } }, diff --git a/discovery/policysimulator-v1alpha.json b/discovery/policysimulator-v1alpha.json index d8f38651b9..2ed93dccd0 100644 --- a/discovery/policysimulator-v1alpha.json +++ b/discovery/policysimulator-v1alpha.json @@ -457,6 +457,34 @@ "resources": { "orgPolicyViolationsPreviews": { "methods": { + "generate": { + "description": "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.", + "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews:generate", + "httpMethod": "POST", + "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/orgPolicyViolationsPreviews:generate", + "request": { + "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available for at least 7 days.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}", @@ -492,13 +520,13 @@ ], "parameters": { "pageSize": { - "description": "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.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "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.", + "description": "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.", "location": "query", "type": "string" }, @@ -561,13 +589,13 @@ ], "parameters": { "pageSize": { - "description": "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.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "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.", + "description": "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.", "location": "query", "type": "string" }, @@ -1047,7 +1075,7 @@ } } }, - "revision": "20231217", + "revision": "20240128", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1754,14 +1782,14 @@ "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", "properties": { "customConstraints": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay" }, "type": "array" }, "policies": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay" }, @@ -1776,10 +1804,10 @@ "properties": { "customConstraint": { "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "The new or updated custom constraint." + "description": "Optional. The new or updated custom constraint." }, "customConstraintParent": { - "description": "Resource the constraint is attached to. Example: \"organization/987654\"", + "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", "type": "string" } }, @@ -1791,10 +1819,10 @@ "properties": { "policy": { "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "The new or updated OrgPolicy." + "description": "Optional. The new or updated OrgPolicy." }, "policyParent": { - "description": "The parent of the policy we are attaching to. Example: \"projects/123456\"", + "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", "type": "string" } }, @@ -1888,28 +1916,33 @@ "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", "properties": { "compliant": { - "description": "Number of scanned resources with zero violations.", + "description": "Output only. Number of scanned resources with zero violations.", "format": "int32", + "readOnly": true, "type": "integer" }, "errors": { - "description": "Number of resources that returned an error when scanned.", + "description": "Output only. Number of resources that returned an error when scanned.", "format": "int32", + "readOnly": true, "type": "integer" }, "noncompliant": { - "description": "Number of scanned resources with at least one violation.", + "description": "Output only. Number of scanned resources with at least one violation.", "format": "int32", + "readOnly": true, "type": "integer" }, "scanned": { - "description": "Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", + "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", "format": "int32", + "readOnly": true, "type": "integer" }, "unenforced": { - "description": "Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", + "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", "format": "int32", + "readOnly": true, "type": "integer" } }, @@ -2135,14 +2168,14 @@ "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", "properties": { "customConstraints": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay" }, "type": "array" }, "policies": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay" }, @@ -2157,10 +2190,10 @@ "properties": { "customConstraint": { "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "The new or updated custom constraint." + "description": "Optional. The new or updated custom constraint." }, "customConstraintParent": { - "description": "Resource the constraint is attached to. Example: \"organization/987654\"", + "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", "type": "string" } }, @@ -2172,10 +2205,10 @@ "properties": { "policy": { "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "The new or updated OrgPolicy." + "description": "Optional. The new or updated OrgPolicy." }, "policyParent": { - "description": "The parent of the policy we are attaching to. Example: \"projects/123456\"", + "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", "type": "string" } }, @@ -2246,28 +2279,33 @@ "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", "properties": { "compliant": { - "description": "Number of scanned resources with zero violations.", + "description": "Output only. Number of scanned resources with zero violations.", "format": "int32", + "readOnly": true, "type": "integer" }, "errors": { - "description": "Number of resources that returned an error when scanned.", + "description": "Output only. Number of resources that returned an error when scanned.", "format": "int32", + "readOnly": true, "type": "integer" }, "noncompliant": { - "description": "Number of scanned resources with at least one violation.", + "description": "Output only. Number of scanned resources with at least one violation.", "format": "int32", + "readOnly": true, "type": "integer" }, "scanned": { - "description": "Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", + "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", "format": "int32", + "readOnly": true, "type": "integer" }, "unenforced": { - "description": "Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", + "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", "format": "int32", + "readOnly": true, "type": "integer" } }, @@ -2337,7 +2375,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "description": "Role that is assigned to the list of `members`, or principals. For example, `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).", "type": "string" } }, diff --git a/discovery/policysimulator-v1beta.json b/discovery/policysimulator-v1beta.json index 6c02cdde64..9434eb0b8d 100644 --- a/discovery/policysimulator-v1beta.json +++ b/discovery/policysimulator-v1beta.json @@ -457,6 +457,34 @@ "resources": { "orgPolicyViolationsPreviews": { "methods": { + "generate": { + "description": "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.", + "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews:generate", + "httpMethod": "POST", + "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/orgPolicyViolationsPreviews:generate", + "request": { + "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available for at least 7 days.", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}", @@ -492,13 +520,13 @@ ], "parameters": { "pageSize": { - "description": "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.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "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.", + "description": "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.", "location": "query", "type": "string" }, @@ -561,13 +589,13 @@ ], "parameters": { "pageSize": { - "description": "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.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "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.", + "description": "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.", "location": "query", "type": "string" }, @@ -1047,7 +1075,7 @@ } } }, - "revision": "20231217", + "revision": "20240128", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1410,14 +1438,14 @@ "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", "properties": { "customConstraints": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay" }, "type": "array" }, "policies": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay" }, @@ -1432,10 +1460,10 @@ "properties": { "customConstraint": { "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "The new or updated custom constraint." + "description": "Optional. The new or updated custom constraint." }, "customConstraintParent": { - "description": "Resource the constraint is attached to. Example: \"organization/987654\"", + "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", "type": "string" } }, @@ -1447,10 +1475,10 @@ "properties": { "policy": { "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "The new or updated OrgPolicy." + "description": "Optional. The new or updated OrgPolicy." }, "policyParent": { - "description": "The parent of the policy we are attaching to. Example: \"projects/123456\"", + "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", "type": "string" } }, @@ -1521,28 +1549,33 @@ "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", "properties": { "compliant": { - "description": "Number of scanned resources with zero violations.", + "description": "Output only. Number of scanned resources with zero violations.", "format": "int32", + "readOnly": true, "type": "integer" }, "errors": { - "description": "Number of resources that returned an error when scanned.", + "description": "Output only. Number of resources that returned an error when scanned.", "format": "int32", + "readOnly": true, "type": "integer" }, "noncompliant": { - "description": "Number of scanned resources with at least one violation.", + "description": "Output only. Number of scanned resources with at least one violation.", "format": "int32", + "readOnly": true, "type": "integer" }, "scanned": { - "description": "Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", + "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", "format": "int32", + "readOnly": true, "type": "integer" }, "unenforced": { - "description": "Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", + "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", "format": "int32", + "readOnly": true, "type": "integer" } }, @@ -1947,14 +1980,14 @@ "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", "properties": { "customConstraints": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay" }, "type": "array" }, "policies": { - "description": "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.", + "description": "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.", "items": { "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay" }, @@ -1969,10 +2002,10 @@ "properties": { "customConstraint": { "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "The new or updated custom constraint." + "description": "Optional. The new or updated custom constraint." }, "customConstraintParent": { - "description": "Resource the constraint is attached to. Example: \"organization/987654\"", + "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", "type": "string" } }, @@ -1984,10 +2017,10 @@ "properties": { "policy": { "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "The new or updated OrgPolicy." + "description": "Optional. The new or updated OrgPolicy." }, "policyParent": { - "description": "The parent of the policy we are attaching to. Example: \"projects/123456\"", + "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", "type": "string" } }, @@ -2081,28 +2114,33 @@ "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", "properties": { "compliant": { - "description": "Number of scanned resources with zero violations.", + "description": "Output only. Number of scanned resources with zero violations.", "format": "int32", + "readOnly": true, "type": "integer" }, "errors": { - "description": "Number of resources that returned an error when scanned.", + "description": "Output only. Number of resources that returned an error when scanned.", "format": "int32", + "readOnly": true, "type": "integer" }, "noncompliant": { - "description": "Number of scanned resources with at least one violation.", + "description": "Output only. Number of scanned resources with at least one violation.", "format": "int32", + "readOnly": true, "type": "integer" }, "scanned": { - "description": "Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", + "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", "format": "int32", + "readOnly": true, "type": "integer" }, "unenforced": { - "description": "Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", + "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", "format": "int32", + "readOnly": true, "type": "integer" } }, @@ -2337,7 +2375,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "description": "Role that is assigned to the list of `members`, or principals. For example, `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).", "type": "string" } }, diff --git a/src/apis/policysimulator/v1.ts b/src/apis/policysimulator/v1.ts index 2b120511b4..af8c324e26 100644 --- a/src/apis/policysimulator/v1.ts +++ b/src/apis/policysimulator/v1.ts @@ -336,11 +336,11 @@ export namespace policysimulator_v1 { */ export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay { /** - * 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. */ customConstraints?: Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay[]; /** - * 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. */ policies?: Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay[]; } @@ -349,11 +349,11 @@ export namespace policysimulator_v1 { */ export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay { /** - * The new or updated custom constraint. + * Optional. The new or updated custom constraint. */ customConstraint?: Schema$GoogleCloudOrgpolicyV2CustomConstraint; /** - * Resource the constraint is attached to. Example: "organization/987654" + * Optional. Resource the constraint is attached to. Example: "organization/987654" */ customConstraintParent?: string | null; } @@ -362,11 +362,11 @@ export namespace policysimulator_v1 { */ export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay { /** - * The new or updated OrgPolicy. + * Optional. The new or updated OrgPolicy. */ policy?: Schema$GoogleCloudOrgpolicyV2Policy; /** - * 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" */ policyParent?: string | null; } @@ -408,23 +408,23 @@ export namespace policysimulator_v1 { */ export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts { /** - * Number of scanned resources with zero violations. + * Output only. Number of scanned resources with zero violations. */ compliant?: number | null; /** - * Number of resources that returned an error when scanned. + * Output only. Number of resources that returned an error when scanned. */ errors?: number | null; /** - * Number of scanned resources with at least one violation. + * Output only. Number of scanned resources with at least one violation. */ noncompliant?: number | null; /** - * 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 */ scanned?: number | null; /** - * 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. */ unenforced?: number | null; } @@ -462,11 +462,11 @@ export namespace policysimulator_v1 { */ export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay { /** - * 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. */ customConstraints?: Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay[]; /** - * 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. */ policies?: Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay[]; } @@ -475,11 +475,11 @@ export namespace policysimulator_v1 { */ export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay { /** - * The new or updated custom constraint. + * Optional. The new or updated custom constraint. */ customConstraint?: Schema$GoogleCloudOrgpolicyV2CustomConstraint; /** - * Resource the constraint is attached to. Example: "organization/987654" + * Optional. Resource the constraint is attached to. Example: "organization/987654" */ customConstraintParent?: string | null; } @@ -488,11 +488,11 @@ export namespace policysimulator_v1 { */ export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay { /** - * The new or updated OrgPolicy. + * Optional. The new or updated OrgPolicy. */ policy?: Schema$GoogleCloudOrgpolicyV2Policy; /** - * 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" */ policyParent?: string | null; } @@ -534,23 +534,23 @@ export namespace policysimulator_v1 { */ export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts { /** - * Number of scanned resources with zero violations. + * Output only. Number of scanned resources with zero violations. */ compliant?: number | null; /** - * Number of resources that returned an error when scanned. + * Output only. Number of resources that returned an error when scanned. */ errors?: number | null; /** - * Number of scanned resources with at least one violation. + * Output only. Number of scanned resources with at least one violation. */ noncompliant?: number | null; /** - * 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 */ scanned?: number | null; /** - * 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. */ unenforced?: number | null; } @@ -808,7 +808,7 @@ export namespace policysimulator_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * Role that is assigned to the list of `members`, or principals. For example, `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). */ role?: string | null; }