Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(policysimulator): update the api
#### policysimulator:v1 The following keys were added: - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.create (Total Keys: 14) - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.get (Total Keys: 11) - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.list (Total Keys: 16) - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.resources.orgPolicyViolations.methods.list (Total Keys: 16) - schemas.GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse (Total Keys: 5) - schemas.GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse (Total Keys: 5) - schemas.GoogleCloudPolicysimulatorV1OrgPolicyOverlay (Total Keys: 14) - schemas.GoogleCloudPolicysimulatorV1OrgPolicyViolation (Total Keys: 41) - schemas.GoogleCloudPolicysimulatorV1ResourceContext (Total Keys: 6) - schemas.GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata (Total Keys: 14) - schemas.GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata (Total Keys: 14) #### policysimulator:v1alpha The following keys were deleted: - resources.organizations.resources.locations.methods.orgPolicyViolationsPreviews (Total Keys: 12) The following keys were added: - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.create (Total Keys: 14) - schemas.GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata (Total Keys: 14) - schemas.GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata (Total Keys: 14) #### policysimulator:v1beta The following keys were deleted: - resources.organizations.resources.locations.methods.orgPolicyViolationsPreviews (Total Keys: 12) The following keys were added: - resources.organizations.resources.locations.resources.orgPolicyViolationsPreviews.methods.create (Total Keys: 14) - schemas.GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata (Total Keys: 14) - schemas.GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata (Total Keys: 14)
- Loading branch information
1 parent
f63789a
commit 694d970
Showing
8 changed files
with
1,708 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
499 changes: 497 additions & 2 deletions
499
docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html
Large diffs are not rendered by default.
Oops, something went wrong.
162 changes: 162 additions & 0 deletions
162
...simulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| <html><body> | ||
| <style> | ||
|
|
||
| body, h1, h2, h3, div, span, p, pre, a { | ||
| margin: 0; | ||
| padding: 0; | ||
| border: 0; | ||
| font-weight: inherit; | ||
| font-style: inherit; | ||
| font-size: 100%; | ||
| font-family: inherit; | ||
| vertical-align: baseline; | ||
| } | ||
|
|
||
| body { | ||
| font-size: 13px; | ||
| padding: 1em; | ||
| } | ||
|
|
||
| h1 { | ||
| font-size: 26px; | ||
| margin-bottom: 1em; | ||
| } | ||
|
|
||
| h2 { | ||
| font-size: 24px; | ||
| margin-bottom: 1em; | ||
| } | ||
|
|
||
| h3 { | ||
| font-size: 20px; | ||
| margin-bottom: 1em; | ||
| margin-top: 1em; | ||
| } | ||
|
|
||
| pre, code { | ||
| line-height: 1.5; | ||
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | ||
| } | ||
|
|
||
| pre { | ||
| margin-top: 0.5em; | ||
| } | ||
|
|
||
| h1, h2, h3, p { | ||
| font-family: Arial, sans serif; | ||
| } | ||
|
|
||
| h1, h2, h3 { | ||
| border-bottom: solid #CCC 1px; | ||
| } | ||
|
|
||
| .toc_element { | ||
| margin-top: 0.5em; | ||
| } | ||
|
|
||
| .firstline { | ||
| margin-left: 2 em; | ||
| } | ||
|
|
||
| .method { | ||
| margin-top: 1em; | ||
| border: solid 1px #CCC; | ||
| padding: 1em; | ||
| background: #EEE; | ||
| } | ||
|
|
||
| .details { | ||
| font-weight: bold; | ||
| font-size: 14px; | ||
| } | ||
|
|
||
| </style> | ||
|
|
||
| <h1><a href="policysimulator_v1.html">Policy Simulator API</a> . <a href="policysimulator_v1.organizations.html">organizations</a> . <a href="policysimulator_v1.organizations.locations.html">locations</a> . <a href="policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html">orgPolicyViolationsPreviews</a> . <a href="policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html">orgPolicyViolations</a></h1> | ||
| <h2>Instance Methods</h2> | ||
| <p class="toc_element"> | ||
| <code><a href="#close">close()</a></code></p> | ||
| <p class="firstline">Close httplib2 connections.</p> | ||
| <p class="toc_element"> | ||
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | ||
| <p class="firstline">ListOrgPolicyViolations lists the OrgPolicyViolations that are present in an OrgPolicyViolationsPreview.</p> | ||
| <p class="toc_element"> | ||
| <code><a href="#list_next">list_next()</a></code></p> | ||
| <p class="firstline">Retrieves the next page of results.</p> | ||
| <h3>Method Details</h3> | ||
| <div class="method"> | ||
| <code class="details" id="close">close()</code> | ||
| <pre>Close httplib2 connections.</pre> | ||
| </div> | ||
|
|
||
| <div class="method"> | ||
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> | ||
| <pre>ListOrgPolicyViolations lists the OrgPolicyViolations that are present in an OrgPolicyViolationsPreview. | ||
|
|
||
| Args: | ||
| parent: string, Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview} (required) | ||
| pageSize: integer, 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. | ||
| pageToken: string, 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. | ||
| x__xgafv: string, V1 error format. | ||
| Allowed values | ||
| 1 - v1 error format | ||
| 2 - v2 error format | ||
|
|
||
| Returns: | ||
| An object of the form: | ||
|
|
||
| { # ListOrgPolicyViolationsResponse is the response message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolations | ||
| "nextPageToken": "A String", # A token that you can use to retrieve the next page of results. If this field is omitted, there are no subsequent pages. | ||
| "orgPolicyViolations": [ # The list of OrgPolicyViolations | ||
| { # OrgPolicyViolation is a resource representing a single resource violating a single OrgPolicy constraint. | ||
| "customConstraint": { # 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*. # The custom constraint being violated. | ||
| "actionType": "A String", # Allow or deny type. | ||
| "condition": "A String", # Org policy condition/expression. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. | ||
| "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. | ||
| "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. | ||
| "methodTypes": [ # All the operations being applied for this constraint. | ||
| "A String", | ||
| ], | ||
| "name": "A String", # 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. | ||
| "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. | ||
| "A String", | ||
| ], | ||
| "updateTime": "A String", # Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` RPC was called | ||
| }, | ||
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error encountered during the evaluation. | ||
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | ||
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | ||
| { | ||
| "a_key": "", # Properties of the object. Contains field @type with type URL. | ||
| }, | ||
| ], | ||
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | ||
| }, | ||
| "name": "A String", # The name of the `OrgPolicyViolation`. Example: organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce` | ||
| "resource": { # ResourceContext provides the context we know about a resource. It is similar in concept to google.cloud.asset.v1.Resource, but focuses on the information specifically used by Simulator. # The resource violating the constraint. | ||
| "ancestors": [ # The ancestry path of the resource in Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the resource is a project, folder, or organization, the ancestry path starts from the resource itself. Example: `["projects/123456789", "folders/5432", "organizations/1234"]` | ||
| "A String", | ||
| ], | ||
| "assetType": "A String", # The asset type of the resource as defined by CAIS. Example: `compute.googleapis.com/Firewall` See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information. | ||
| "resource": "A String", # The full name of the resource. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` See [Resource names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. | ||
| }, | ||
| }, | ||
| ], | ||
| }</pre> | ||
| </div> | ||
|
|
||
| <div class="method"> | ||
| <code class="details" id="list_next">list_next()</code> | ||
| <pre>Retrieves the next page of results. | ||
|
|
||
| Args: | ||
| previous_request: The request for the previous page. (required) | ||
| previous_response: The response from the request for the previous page. (required) | ||
|
|
||
| Returns: | ||
| A request object that you can call 'execute()' on to request the next | ||
| page. Returns None if there are no more items in the collection. | ||
| </pre> | ||
| </div> | ||
|
|
||
| </body></html> |
Oops, something went wrong.