Interface OrgPolicyViolationsPreviewServiceGrpc.AsyncService (0.49.0)

public static interface OrgPolicyViolationsPreviewServiceGrpc.AsyncService

Violations Preview API service for OrgPolicy. An OrgPolicyViolationsPreview is a preview of the violations that will exist as soon as a proposed OrgPolicy change is submitted. To create an OrgPolicyViolationsPreview, the API user specifies the changes they wish to make and requests the generation of a preview via [GenerateViolationsPreview][]. the OrgPolicy Simulator service then scans the API user's currently existing resources to determine these resources violate the newly set OrgPolicy.

Methods

createOrgPolicyViolationsPreview(CreateOrgPolicyViolationsPreviewRequest request, StreamObserver<Operation> responseObserver)

public default void createOrgPolicyViolationsPreview(CreateOrgPolicyViolationsPreviewRequest request, StreamObserver<Operation> responseObserver)

CreateOrgPolicyViolationsPreview creates 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.

Parameters
Name Description
request CreateOrgPolicyViolationsPreviewRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getOrgPolicyViolationsPreview(GetOrgPolicyViolationsPreviewRequest request, StreamObserver<OrgPolicyViolationsPreview> responseObserver)

public default void getOrgPolicyViolationsPreview(GetOrgPolicyViolationsPreviewRequest request, StreamObserver<OrgPolicyViolationsPreview> responseObserver)

GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available for at least 7 days.

Parameters
Name Description
request GetOrgPolicyViolationsPreviewRequest
responseObserver io.grpc.stub.StreamObserver<OrgPolicyViolationsPreview>

listOrgPolicyViolations(ListOrgPolicyViolationsRequest request, StreamObserver<ListOrgPolicyViolationsResponse> responseObserver)

public default void listOrgPolicyViolations(ListOrgPolicyViolationsRequest request, StreamObserver<ListOrgPolicyViolationsResponse> responseObserver)

ListOrgPolicyViolations lists the [OrgPolicyViolations][] that are present in an OrgPolicyViolationsPreview.

Parameters
Name Description
request ListOrgPolicyViolationsRequest
responseObserver io.grpc.stub.StreamObserver<ListOrgPolicyViolationsResponse>

listOrgPolicyViolationsPreviews(ListOrgPolicyViolationsPreviewsRequest request, StreamObserver<ListOrgPolicyViolationsPreviewsResponse> responseObserver)

public default void listOrgPolicyViolationsPreviews(ListOrgPolicyViolationsPreviewsRequest request, StreamObserver<ListOrgPolicyViolationsPreviewsResponse> responseObserver)

ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in an organization. Each OrgPolicyViolationsPreview is available for at least 7 days.

Parameters
Name Description
request ListOrgPolicyViolationsPreviewsRequest
responseObserver io.grpc.stub.StreamObserver<ListOrgPolicyViolationsPreviewsResponse>