google-api-python-client 2.172.0__py3-none-any.whl → 2.174.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json

@@ -521,9 +521,213 @@
 }
 }
 },
-"revision": "20250323",
+"revision": "20250614",
 "rootUrl": "https://policysimulator.googleapis.com/",
 "schemas": {
+"GoogleCloudOrgpolicyV2AlternatePolicySpec": {
+"description": "Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run.",
+"id": "GoogleCloudOrgpolicyV2AlternatePolicySpec",
+"properties": {
+"launch": {
+"description": "Reference to the launch that will be used while audit logging and to control the launch. Should be set only in the alternate policy.",
+"type": "string"
+},
+"spec": {
+"$ref": "GoogleCloudOrgpolicyV2PolicySpec",
+"description": "Specify constraint for configurations of Google Cloud resources."
+}
+},
+"type": "object"
+},
+"GoogleCloudOrgpolicyV2CustomConstraint": {
+"description": "A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*.",
+"id": "GoogleCloudOrgpolicyV2CustomConstraint",
+"properties": {
+"actionType": {
+"description": "Allow or deny type.",
+"enum": [
+"ACTION_TYPE_UNSPECIFIED",
+"ALLOW",
+"DENY"
+],
+"enumDescriptions": [
+"This is only used for distinguishing unset values and should never be used. Results in an error.",
+"Allowed action type.",
+"Deny action type."
+],
+"type": "string"
+},
+"condition": {
+"description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"[production|test]_.*_(\\d)+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.",
+"type": "string"
+},
+"description": {
+"description": "Detailed information about this custom policy constraint. The max length of the description is 2000 characters.",
+"type": "string"
+},
+"displayName": {
+"description": "One line display name for the UI. The max length of the display_name is 200 characters.",
+"type": "string"
+},
+"methodTypes": {
+"description": "All the operations being applied for this constraint.",
+"items": {
+"enum": [
+"METHOD_TYPE_UNSPECIFIED",
+"CREATE",
+"UPDATE",
+"DELETE",
+"REMOVE_GRANT",
+"GOVERN_TAGS"
+],
+"enumDescriptions": [
+"This is only used for distinguishing unset values and should never be used. Results in an error.",
+"Constraint applied when creating the resource.",
+"Constraint applied when updating the resource.",
+"Constraint applied when deleting the resource. Not currently supported.",
+"Constraint applied when removing an IAM grant.",
+"Constraint applied when enforcing forced tagging."
+],
+"type": "string"
+},
+"type": "array"
+},
+"name": {
+"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.",
+"type": "string"
+},
+"resourceTypes": {
+"description": "Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"updateTime": {
+"description": "Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` methods were called.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudOrgpolicyV2Policy": {
+"description": "Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.",
+"id": "GoogleCloudOrgpolicyV2Policy",
+"properties": {
+"alternate": {
+"$ref": "GoogleCloudOrgpolicyV2AlternatePolicySpec",
+"deprecated": true,
+"description": "Deprecated."
+},
+"dryRunSpec": {
+"$ref": "GoogleCloudOrgpolicyV2PolicySpec",
+"description": "Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced."
+},
+"etag": {
+"description": "Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This 'etag' is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
+"type": "string"
+},
+"name": {
+"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint which this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.",
+"type": "string"
+},
+"spec": {
+"$ref": "GoogleCloudOrgpolicyV2PolicySpec",
+"description": "Basic information about the organization policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudOrgpolicyV2PolicySpec": {
+"description": "Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources.",
+"id": "GoogleCloudOrgpolicyV2PolicySpec",
+"properties": {
+"etag": {
+"description": "An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this `etag` indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the `etag` will be unset.",
+"type": "string"
+},
+"inheritFromParent": {
+"description": "Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.",
+"type": "boolean"
+},
+"reset": {
+"description": "Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false.",
+"type": "boolean"
+},
+"rules": {
+"description": "In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.",
+"items": {
+"$ref": "GoogleCloudOrgpolicyV2PolicySpecPolicyRule"
+},
+"type": "array"
+},
+"updateTime": {
+"description": "Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudOrgpolicyV2PolicySpecPolicyRule": {
+"description": "A rule used to express this policy.",
+"id": "GoogleCloudOrgpolicyV2PolicySpecPolicyRule",
+"properties": {
+"allowAll": {
+"description": "Setting this to true means that all values are allowed. This field can be set only in policies for list constraints.",
+"type": "boolean"
+},
+"condition": {
+"$ref": "GoogleTypeExpr",
+"description": "A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the `Expr' must include from 1 to 10 subexpressions, joined by the \"||\" or \"&&\" operators. Each subexpression must be of the form \"resource.matchTag('/tag_key_short_name, 'tag_value_short_name')\". or \"resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')\". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: \"resource.matchTag('123456789/environment, 'prod')\". or \"resource.matchTagId('tagKeys/123', 'tagValues/456')\"."
+},
+"denyAll": {
+"description": "Setting this to true means that all values are denied. This field can be set only in policies for list constraints.",
+"type": "boolean"
+},
+"enforce": {
+"description": "If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints.",
+"type": "boolean"
+},
+"parameters": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { \"allowedLocations\" : [\"us-east1\", \"us-west1\"], \"allowAll\" : true }",
+"type": "object"
+},
+"values": {
+"$ref": "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues",
+"description": "List of values to be used for this policy rule. This field can be set only in policies for list constraints."
+}
+},
+"type": "object"
+},
+"GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues": {
+"description": "A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a \":\". Values prefixed with \"is:\" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - `projects/` (for example, `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - `organizations/` (for example, `organizations/1234`) The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used.",
+"id": "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues",
+"properties": {
+"allowedValues": {
+"description": "List of values allowed at this resource.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"deniedValues": {
+"description": "List of values denied at this resource.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudPolicysimulatorV1Replay": {
 "description": "A resource describing a `Replay`, or simulation.",
 "id": "GoogleCloudPolicysimulatorV1Replay",
@@ -637,6 +841,255 @@
 },
 "type": "object"
 },
+"GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata": {
+"description": "CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.",
+"id": "GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata",
+"properties": {
+"requestTime": {
+"description": "Time when the request was received.",
+"format": "google-datetime",
+"type": "string"
+},
+"resourcesFound": {
+"description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending",
+"format": "int32",
+"type": "integer"
+},
+"resourcesPending": {
+"description": "Number of resources still to scan.",
+"format": "int32",
+"type": "integer"
+},
+"resourcesScanned": {
+"description": "Number of resources already scanned.",
+"format": "int32",
+"type": "integer"
+},
+"startTime": {
+"description": "Time when the request started processing, i.e., when the state was set to RUNNING.",
+"format": "google-datetime",
+"type": "string"
+},
+"state": {
+"description": "Output only. The current state of the operation.",
+"enum": [
+"PREVIEW_STATE_UNSPECIFIED",
+"PREVIEW_PENDING",
+"PREVIEW_RUNNING",
+"PREVIEW_SUCCEEDED",
+"PREVIEW_FAILED"
+],
+"enumDescriptions": [
+"The state is unspecified.",
+"The OrgPolicyViolationsPreview has not been created yet.",
+"The OrgPolicyViolationsPreview is currently being created.",
+"The OrgPolicyViolationsPreview creation finished successfully.",
+"The OrgPolicyViolationsPreview creation failed with an error."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata": {
+"description": "GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.",
+"id": "GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata",
+"properties": {
+"requestTime": {
+"description": "Time when the request was received.",
+"format": "google-datetime",
+"type": "string"
+},
+"resourcesFound": {
+"description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending",
+"format": "int32",
+"type": "integer"
+},
+"resourcesPending": {
+"description": "Number of resources still to scan.",
+"format": "int32",
+"type": "integer"
+},
+"resourcesScanned": {
+"description": "Number of resources already scanned.",
+"format": "int32",
+"type": "integer"
+},
+"startTime": {
+"description": "Time when the request started processing, i.e. when the state was set to RUNNING.",
+"format": "google-datetime",
+"type": "string"
+},
+"state": {
+"description": "The current state of the operation.",
+"enum": [
+"PREVIEW_STATE_UNSPECIFIED",
+"PREVIEW_PENDING",
+"PREVIEW_RUNNING",
+"PREVIEW_SUCCEEDED",
+"PREVIEW_FAILED"
+],
+"enumDescriptions": [
+"The state is unspecified.",
+"The OrgPolicyViolationsPreview has not been created yet.",
+"The OrgPolicyViolationsPreview is currently being created.",
+"The OrgPolicyViolationsPreview creation finished successfully.",
+"The OrgPolicyViolationsPreview creation failed with an error."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay": {
+"description": "The proposed changes to OrgPolicy.",
+"id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay",
+"properties": {
+"customConstraints": {
+"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": "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"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay": {
+"description": "A change to an OrgPolicy custom constraint.",
+"id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay",
+"properties": {
+"customConstraint": {
+"$ref": "GoogleCloudOrgpolicyV2CustomConstraint",
+"description": "Optional. The new or updated custom constraint."
+},
+"customConstraintParent": {
+"description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay": {
+"description": "A change to an OrgPolicy.",
+"id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay",
+"properties": {
+"policy": {
+"$ref": "GoogleCloudOrgpolicyV2Policy",
+"description": "Optional. The new or updated OrgPolicy."
+},
+"policyParent": {
+"description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview": {
+"description": "OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field.",
+"id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview",
+"properties": {
+"createTime": {
+"description": "Output only. Time when this `OrgPolicyViolationsPreview` was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"customConstraints": {
+"description": "Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"name": {
+"description": "Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`",
+"readOnly": true,
+"type": "string"
+},
+"overlay": {
+"$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay",
+"description": "Required. The proposed changes we are previewing violations for."
+},
+"resourceCounts": {
+"$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts",
+"description": "Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.",
+"readOnly": true
+},
+"state": {
+"description": "Output only. The state of the `OrgPolicyViolationsPreview`.",
+"enum": [
+"PREVIEW_STATE_UNSPECIFIED",
+"PREVIEW_PENDING",
+"PREVIEW_RUNNING",
+"PREVIEW_SUCCEEDED",
+"PREVIEW_FAILED"
+],
+"enumDescriptions": [
+"The state is unspecified.",
+"The OrgPolicyViolationsPreview has not been created yet.",
+"The OrgPolicyViolationsPreview is currently being created.",
+"The OrgPolicyViolationsPreview creation finished successfully.",
+"The OrgPolicyViolationsPreview creation failed with an error."
+],
+"readOnly": true,
+"type": "string"
+},
+"violationsCount": {
+"description": "Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts": {
+"description": "A summary of the state of all resources scanned for compliance with the changed OrgPolicy.",
+"id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts",
+"properties": {
+"compliant": {
+"description": "Output only. Number of scanned resources with zero violations.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"errors": {
+"description": "Output only. Number of resources that returned an error when scanned.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"noncompliant": {
+"description": "Output only. Number of scanned resources with at least one violation.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"scanned": {
+"description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"unenforced": {
+"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"
+}
+},
+"type": "object"
+},
 "GoogleIamV1AuditConfig": {
 "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
 "id": "GoogleIamV1AuditConfig",