Policy Simulator v1 API - Class OrgPolicyViolationsPreviewServiceClientImpl (1.3.0) 

public sealed class OrgPolicyViolationsPreviewServiceClientImpl : OrgPolicyViolationsPreviewServiceClient

Reference documentation and code samples for the Policy Simulator v1 API class OrgPolicyViolationsPreviewServiceClientImpl.

OrgPolicyViolationsPreviewService client wrapper implementation, for convenient use.

Inheritance

object > OrgPolicyViolationsPreviewServiceClient > OrgPolicyViolationsPreviewServiceClientImpl

Namespace

Google.Cloud.PolicySimulator.V1

Assembly

Google.Cloud.PolicySimulator.V1.dll

Remarks

Violations Preview API service for OrgPolicy.

An [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview] is a preview of the violations that will exist as soon as a proposed OrgPolicy change is submitted. To create an [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.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.

Constructors

OrgPolicyViolationsPreviewServiceClientImpl(OrgPolicyViolationsPreviewServiceClient, OrgPolicyViolationsPreviewServiceSettings, ILogger)

public OrgPolicyViolationsPreviewServiceClientImpl(OrgPolicyViolationsPreviewService.OrgPolicyViolationsPreviewServiceClient grpcClient, OrgPolicyViolationsPreviewServiceSettings settings, ILogger logger)

Constructs a client wrapper for the OrgPolicyViolationsPreviewService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient OrgPolicyViolationsPreviewServiceOrgPolicyViolationsPreviewServiceClient

The underlying gRPC client.
settings OrgPolicyViolationsPreviewServiceSettings

The base OrgPolicyViolationsPreviewServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateOrgPolicyViolationsPreviewOperationsClient

public override OperationsClient CreateOrgPolicyViolationsPreviewOperationsClient { get; }

The long-running operations client for CreateOrgPolicyViolationsPreview.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override OrgPolicyViolationsPreviewService.OrgPolicyViolationsPreviewServiceClient GrpcClient { get; }

The underlying gRPC OrgPolicyViolationsPreviewService client

Property Value
Type Description
OrgPolicyViolationsPreviewServiceOrgPolicyViolationsPreviewServiceClient
Overrides

Methods

CreateOrgPolicyViolationsPreview(CreateOrgPolicyViolationsPreviewRequest, CallSettings)

public override Operation<OrgPolicyViolationsPreview, CreateOrgPolicyViolationsPreviewOperationMetadata> CreateOrgPolicyViolationsPreview(CreateOrgPolicyViolationsPreviewRequest request, CallSettings callSettings = null)

CreateOrgPolicyViolationsPreview creates an [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.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

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOrgPolicyViolationsPreviewCreateOrgPolicyViolationsPreviewOperationMetadata

The RPC response.
Overrides

CreateOrgPolicyViolationsPreviewAsync(CreateOrgPolicyViolationsPreviewRequest, CallSettings)

public override Task<Operation<OrgPolicyViolationsPreview, CreateOrgPolicyViolationsPreviewOperationMetadata>> CreateOrgPolicyViolationsPreviewAsync(CreateOrgPolicyViolationsPreviewRequest request, CallSettings callSettings = null)

CreateOrgPolicyViolationsPreview creates an [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.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

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOrgPolicyViolationsPreviewCreateOrgPolicyViolationsPreviewOperationMetadata

A Task containing the RPC response.
Overrides

GetOrgPolicyViolationsPreview(GetOrgPolicyViolationsPreviewRequest, CallSettings)

public override OrgPolicyViolationsPreview GetOrgPolicyViolationsPreview(GetOrgPolicyViolationsPreviewRequest request, CallSettings callSettings = null)

GetOrgPolicyViolationsPreview gets the specified [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview]. Each [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview] is available for at least 7 days.

Parameters
Name Description
request GetOrgPolicyViolationsPreviewRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OrgPolicyViolationsPreview

The RPC response.
Overrides

GetOrgPolicyViolationsPreviewAsync(GetOrgPolicyViolationsPreviewRequest, CallSettings)

public override Task<OrgPolicyViolationsPreview> GetOrgPolicyViolationsPreviewAsync(GetOrgPolicyViolationsPreviewRequest request, CallSettings callSettings = null)

GetOrgPolicyViolationsPreview gets the specified [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview]. Each [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview] is available for at least 7 days.

Parameters
Name Description
request GetOrgPolicyViolationsPreviewRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOrgPolicyViolationsPreview

A Task containing the RPC response.
Overrides

ListOrgPolicyViolations(ListOrgPolicyViolationsRequest, CallSettings)

public override PagedEnumerable<ListOrgPolicyViolationsResponse, OrgPolicyViolation> ListOrgPolicyViolations(ListOrgPolicyViolationsRequest request, CallSettings callSettings = null)

ListOrgPolicyViolations lists the [OrgPolicyViolations][] that are present in an [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview].

Parameters
Name Description
request ListOrgPolicyViolationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListOrgPolicyViolationsResponseOrgPolicyViolation

A pageable sequence of OrgPolicyViolation resources.
Overrides

ListOrgPolicyViolationsAsync(ListOrgPolicyViolationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOrgPolicyViolationsResponse, OrgPolicyViolation> ListOrgPolicyViolationsAsync(ListOrgPolicyViolationsRequest request, CallSettings callSettings = null)

ListOrgPolicyViolations lists the [OrgPolicyViolations][] that are present in an [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview].

Parameters
Name Description
request ListOrgPolicyViolationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListOrgPolicyViolationsResponseOrgPolicyViolation

A pageable asynchronous sequence of OrgPolicyViolation resources.
Overrides

ListOrgPolicyViolationsPreviews(ListOrgPolicyViolationsPreviewsRequest, CallSettings)

public override PagedEnumerable<ListOrgPolicyViolationsPreviewsResponse, OrgPolicyViolationsPreview> ListOrgPolicyViolationsPreviews(ListOrgPolicyViolationsPreviewsRequest request, CallSettings callSettings = null)

ListOrgPolicyViolationsPreviews lists each [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview] in an organization. Each [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview] is available for at least 7 days.

Parameters
Name Description
request ListOrgPolicyViolationsPreviewsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListOrgPolicyViolationsPreviewsResponseOrgPolicyViolationsPreview

A pageable sequence of OrgPolicyViolationsPreview resources.
Overrides

ListOrgPolicyViolationsPreviewsAsync(ListOrgPolicyViolationsPreviewsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOrgPolicyViolationsPreviewsResponse, OrgPolicyViolationsPreview> ListOrgPolicyViolationsPreviewsAsync(ListOrgPolicyViolationsPreviewsRequest request, CallSettings callSettings = null)

ListOrgPolicyViolationsPreviews lists each [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview] in an organization. Each [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview] is available for at least 7 days.

Parameters
Name Description
request ListOrgPolicyViolationsPreviewsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListOrgPolicyViolationsPreviewsResponseOrgPolicyViolationsPreview

A pageable asynchronous sequence of OrgPolicyViolationsPreview resources.
Overrides