Audit Manager v1 API - Class AuditManagerClientImpl (1.2.0)

public sealed class AuditManagerClientImpl : AuditManagerClient

Reference documentation and code samples for the Audit Manager v1 API class AuditManagerClientImpl.

AuditManager client wrapper implementation, for convenient use.

Inheritance

object > AuditManagerClient > AuditManagerClientImpl

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Remarks

Service describing handlers for resources

Constructors

AuditManagerClientImpl(AuditManagerClient, AuditManagerSettings, ILogger)

public AuditManagerClientImpl(AuditManager.AuditManagerClient grpcClient, AuditManagerSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient AuditManagerAuditManagerClient

The underlying gRPC client.

settings AuditManagerSettings

The base AuditManagerSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

GenerateAuditReportOperationsClient

public override OperationsClient GenerateAuditReportOperationsClient { get; }

The long-running operations client for GenerateAuditReport.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override AuditManager.AuditManagerClient GrpcClient { get; }

The underlying gRPC AuditManager client

Property Value
Type Description
AuditManagerAuditManagerClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

EnrollResource(EnrollResourceRequest, CallSettings)

public override Enrollment EnrollResource(EnrollResourceRequest request, CallSettings callSettings = null)

Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.

Parameters
Name Description
request EnrollResourceRequest

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
Enrollment

The RPC response.

Overrides

EnrollResourceAsync(EnrollResourceRequest, CallSettings)

public override Task<Enrollment> EnrollResourceAsync(EnrollResourceRequest request, CallSettings callSettings = null)

Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.

Parameters
Name Description
request EnrollResourceRequest

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
TaskEnrollment

A Task containing the RPC response.

Overrides

GenerateAuditReport(GenerateAuditReportRequest, CallSettings)

public override Operation<AuditReport, OperationMetadata> GenerateAuditReport(GenerateAuditReportRequest request, CallSettings callSettings = null)

Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.

Parameters
Name Description
request GenerateAuditReportRequest

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
OperationAuditReportOperationMetadata

The RPC response.

Overrides

GenerateAuditReportAsync(GenerateAuditReportRequest, CallSettings)

public override Task<Operation<AuditReport, OperationMetadata>> GenerateAuditReportAsync(GenerateAuditReportRequest request, CallSettings callSettings = null)

Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.

Parameters
Name Description
request GenerateAuditReportRequest

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
TaskOperationAuditReportOperationMetadata

A Task containing the RPC response.

Overrides

GenerateAuditScopeReport(GenerateAuditScopeReportRequest, CallSettings)

public override AuditScopeReport GenerateAuditScopeReport(GenerateAuditScopeReportRequest request, CallSettings callSettings = null)

Generates an audit scope report for the given standard.

The report includes the following:

  • The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework.
  • A list of Google Cloud services and resources that are within the scope of the framework.
Parameters
Name Description
request GenerateAuditScopeReportRequest

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
AuditScopeReport

The RPC response.

Overrides

GenerateAuditScopeReportAsync(GenerateAuditScopeReportRequest, CallSettings)

public override Task<AuditScopeReport> GenerateAuditScopeReportAsync(GenerateAuditScopeReportRequest request, CallSettings callSettings = null)

Generates an audit scope report for the given standard.

The report includes the following:

  • The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework.
  • A list of Google Cloud services and resources that are within the scope of the framework.
Parameters
Name Description
request GenerateAuditScopeReportRequest

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
TaskAuditScopeReport

A Task containing the RPC response.

Overrides

GetAuditReport(GetAuditReportRequest, CallSettings)

public override AuditReport GetAuditReport(GetAuditReportRequest request, CallSettings callSettings = null)

Gets the full metadata and findings for an audit report.

Parameters
Name Description
request GetAuditReportRequest

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
AuditReport

The RPC response.

Overrides

GetAuditReportAsync(GetAuditReportRequest, CallSettings)

public override Task<AuditReport> GetAuditReportAsync(GetAuditReportRequest request, CallSettings callSettings = null)

Gets the full metadata and findings for an audit report.

Parameters
Name Description
request GetAuditReportRequest

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
TaskAuditReport

A Task containing the RPC response.

Overrides

GetResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest, CallSettings)

public override ResourceEnrollmentStatus GetResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest request, CallSettings callSettings = null)

Gets a resource and its enrollment status.

Parameters
Name Description
request GetResourceEnrollmentStatusRequest

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
ResourceEnrollmentStatus

The RPC response.

Overrides

GetResourceEnrollmentStatusAsync(GetResourceEnrollmentStatusRequest, CallSettings)

public override Task<ResourceEnrollmentStatus> GetResourceEnrollmentStatusAsync(GetResourceEnrollmentStatusRequest request, CallSettings callSettings = null)

Gets a resource and its enrollment status.

Parameters
Name Description
request GetResourceEnrollmentStatusRequest

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
TaskResourceEnrollmentStatus

A Task containing the RPC response.

Overrides

ListAuditReports(ListAuditReportsRequest, CallSettings)

public override PagedEnumerable<ListAuditReportsResponse, AuditReport> ListAuditReports(ListAuditReportsRequest request, CallSettings callSettings = null)

Lists the audit reports for the organization, folder, or project that you specify as the parent scope.

Parameters
Name Description
request ListAuditReportsRequest

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
PagedEnumerableListAuditReportsResponseAuditReport

A pageable sequence of AuditReport resources.

Overrides

ListAuditReportsAsync(ListAuditReportsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAuditReportsResponse, AuditReport> ListAuditReportsAsync(ListAuditReportsRequest request, CallSettings callSettings = null)

Lists the audit reports for the organization, folder, or project that you specify as the parent scope.

Parameters
Name Description
request ListAuditReportsRequest

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
PagedAsyncEnumerableListAuditReportsResponseAuditReport

A pageable asynchronous sequence of AuditReport resources.

Overrides

ListControls(ListControlsRequest, CallSettings)

public override PagedEnumerable<ListControlsResponse, Control> ListControls(ListControlsRequest request, CallSettings callSettings = null)

Lists the controls that you must implement to become compliant to a regulatory standard.

Parameters
Name Description
request ListControlsRequest

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
PagedEnumerableListControlsResponseControl

A pageable sequence of Control resources.

Overrides

ListControlsAsync(ListControlsRequest, CallSettings)

public override PagedAsyncEnumerable<ListControlsResponse, Control> ListControlsAsync(ListControlsRequest request, CallSettings callSettings = null)

Lists the controls that you must implement to become compliant to a regulatory standard.

Parameters
Name Description
request ListControlsRequest

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
PagedAsyncEnumerableListControlsResponseControl

A pageable asynchronous sequence of Control resources.

Overrides

ListResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest, CallSettings)

public override PagedEnumerable<ListResourceEnrollmentStatusesResponse, ResourceEnrollmentStatus> ListResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest request, CallSettings callSettings = null)

Lists all the folders and projects in an organization or folder, along with their enrollments.

Parameters
Name Description
request ListResourceEnrollmentStatusesRequest

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
PagedEnumerableListResourceEnrollmentStatusesResponseResourceEnrollmentStatus

A pageable sequence of ResourceEnrollmentStatus resources.

Overrides

ListResourceEnrollmentStatusesAsync(ListResourceEnrollmentStatusesRequest, CallSettings)

public override PagedAsyncEnumerable<ListResourceEnrollmentStatusesResponse, ResourceEnrollmentStatus> ListResourceEnrollmentStatusesAsync(ListResourceEnrollmentStatusesRequest request, CallSettings callSettings = null)

Lists all the folders and projects in an organization or folder, along with their enrollments.

Parameters
Name Description
request ListResourceEnrollmentStatusesRequest

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
PagedAsyncEnumerableListResourceEnrollmentStatusesResponseResourceEnrollmentStatus

A pageable asynchronous sequence of ResourceEnrollmentStatus resources.

Overrides