Audit Manager v1 API - Class AuditManager.AuditManagerClient (1.0.0-beta01)

public class AuditManager.AuditManagerClient : ClientBase<AuditManager.AuditManagerClient>

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

Client for AuditManager

Inheritance

object > ClientBase > ClientBaseAuditManagerAuditManagerClient > AuditManager.AuditManagerClient

Inherited Members

ClientBase<AuditManager.AuditManagerClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

AuditManagerClient()

protected AuditManagerClient()

Protected parameterless constructor to allow creation of test doubles.

AuditManagerClient(CallInvoker)

public AuditManagerClient(CallInvoker callInvoker)

Creates a new client for AuditManager that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

AuditManagerClient(ChannelBase)

public AuditManagerClient(ChannelBase channel)

Creates a new client for AuditManager

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

AuditManagerClient(ClientBaseConfiguration)

protected AuditManagerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

EnrollResource(EnrollResourceRequest, CallOptions)

public virtual Enrollment EnrollResource(EnrollResourceRequest request, CallOptions options)

Enrolls the customer resource(folder/project/organization) to the audit manager service by creating the audit managers Service Agent in customers workload and granting required permissions to the Service Agent. Please note that if enrollment request is made on the already enrolled workload then enrollment is executed overriding the existing set of destinations.

Parameters
Name	Description
request	EnrollResourceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Enrollment	The response received from the server.

EnrollResource(EnrollResourceRequest, Metadata, DateTime?, CancellationToken)

public virtual Enrollment EnrollResource(EnrollResourceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Enrolls the customer resource(folder/project/organization) to the audit manager service by creating the audit managers Service Agent in customers workload and granting required permissions to the Service Agent. Please note that if enrollment request is made on the already enrolled workload then enrollment is executed overriding the existing set of destinations.

Parameters
Name	Description
request	EnrollResourceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Enrollment	The response received from the server.

EnrollResourceAsync(EnrollResourceRequest, CallOptions)

public virtual AsyncUnaryCall<Enrollment> EnrollResourceAsync(EnrollResourceRequest request, CallOptions options)

Enrolls the customer resource(folder/project/organization) to the audit manager service by creating the audit managers Service Agent in customers workload and granting required permissions to the Service Agent. Please note that if enrollment request is made on the already enrolled workload then enrollment is executed overriding the existing set of destinations.

Parameters
Name	Description
request	EnrollResourceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEnrollment	The call object.

EnrollResourceAsync(EnrollResourceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Enrollment> EnrollResourceAsync(EnrollResourceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Enrolls the customer resource(folder/project/organization) to the audit manager service by creating the audit managers Service Agent in customers workload and granting required permissions to the Service Agent. Please note that if enrollment request is made on the already enrolled workload then enrollment is executed overriding the existing set of destinations.

Parameters
Name	Description
request	EnrollResourceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEnrollment	The call object.

GenerateAuditReport(GenerateAuditReportRequest, CallOptions)

public virtual Operation GenerateAuditReport(GenerateAuditReportRequest request, CallOptions options)

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

Parameters
Name	Description
request	GenerateAuditReportRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

GenerateAuditReport(GenerateAuditReportRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation GenerateAuditReport(GenerateAuditReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

Parameters
Name	Description
request	GenerateAuditReportRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

GenerateAuditReportAsync(GenerateAuditReportRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> GenerateAuditReportAsync(GenerateAuditReportRequest request, CallOptions options)

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

Parameters
Name	Description
request	GenerateAuditReportRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GenerateAuditReportAsync(GenerateAuditReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> GenerateAuditReportAsync(GenerateAuditReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

Parameters
Name	Description
request	GenerateAuditReportRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GenerateAuditScopeReport(GenerateAuditScopeReportRequest, CallOptions)

public virtual AuditScopeReport GenerateAuditScopeReport(GenerateAuditScopeReportRequest request, CallOptions options)

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

Parameters
Name	Description
request	GenerateAuditScopeReportRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AuditScopeReport	The response received from the server.

GenerateAuditScopeReport(GenerateAuditScopeReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AuditScopeReport GenerateAuditScopeReport(GenerateAuditScopeReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

Parameters
Name	Description
request	GenerateAuditScopeReportRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AuditScopeReport	The response received from the server.

GenerateAuditScopeReportAsync(GenerateAuditScopeReportRequest, CallOptions)

public virtual AsyncUnaryCall<AuditScopeReport> GenerateAuditScopeReportAsync(GenerateAuditScopeReportRequest request, CallOptions options)

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

Parameters
Name	Description
request	GenerateAuditScopeReportRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAuditScopeReport	The call object.

GenerateAuditScopeReportAsync(GenerateAuditScopeReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AuditScopeReport> GenerateAuditScopeReportAsync(GenerateAuditScopeReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

Parameters
Name	Description
request	GenerateAuditScopeReportRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallAuditScopeReport	The call object.

GetAuditReport(GetAuditReportRequest, CallOptions)

public virtual AuditReport GetAuditReport(GetAuditReportRequest request, CallOptions options)

Get the overall audit report

Parameters
Name	Description
request	GetAuditReportRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AuditReport	The response received from the server.

GetAuditReport(GetAuditReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AuditReport GetAuditReport(GetAuditReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get the overall audit report

Parameters
Name	Description
request	GetAuditReportRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AuditReport	The response received from the server.

GetAuditReportAsync(GetAuditReportRequest, CallOptions)

public virtual AsyncUnaryCall<AuditReport> GetAuditReportAsync(GetAuditReportRequest request, CallOptions options)

Get the overall audit report

Parameters
Name	Description
request	GetAuditReportRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAuditReport	The call object.

GetAuditReportAsync(GetAuditReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AuditReport> GetAuditReportAsync(GetAuditReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get the overall audit report

Parameters
Name	Description
request	GetAuditReportRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallAuditReport	The call object.

GetResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest, CallOptions)

public virtual ResourceEnrollmentStatus GetResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest request, CallOptions options)

Get a resource along with its enrollment status.

Parameters
Name	Description
request	GetResourceEnrollmentStatusRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ResourceEnrollmentStatus	The response received from the server.

GetResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest, Metadata, DateTime?, CancellationToken)

public virtual ResourceEnrollmentStatus GetResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a resource along with its enrollment status.

Parameters
Name	Description
request	GetResourceEnrollmentStatusRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ResourceEnrollmentStatus	The response received from the server.

GetResourceEnrollmentStatusAsync(GetResourceEnrollmentStatusRequest, CallOptions)

public virtual AsyncUnaryCall<ResourceEnrollmentStatus> GetResourceEnrollmentStatusAsync(GetResourceEnrollmentStatusRequest request, CallOptions options)

Get a resource along with its enrollment status.

Parameters
Name	Description
request	GetResourceEnrollmentStatusRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallResourceEnrollmentStatus	The call object.

GetResourceEnrollmentStatusAsync(GetResourceEnrollmentStatusRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ResourceEnrollmentStatus> GetResourceEnrollmentStatusAsync(GetResourceEnrollmentStatusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a resource along with its enrollment status.

Parameters
Name	Description
request	GetResourceEnrollmentStatusRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallResourceEnrollmentStatus	The call object.

ListAuditReports(ListAuditReportsRequest, CallOptions)

public virtual ListAuditReportsResponse ListAuditReports(ListAuditReportsRequest request, CallOptions options)

Lists audit reports in the selected parent scope

Parameters
Name	Description
request	ListAuditReportsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListAuditReportsResponse	The response received from the server.

ListAuditReports(ListAuditReportsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAuditReportsResponse ListAuditReports(ListAuditReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists audit reports in the selected parent scope

Parameters
Name	Description
request	ListAuditReportsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListAuditReportsResponse	The response received from the server.

ListAuditReportsAsync(ListAuditReportsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAuditReportsResponse> ListAuditReportsAsync(ListAuditReportsRequest request, CallOptions options)

Lists audit reports in the selected parent scope

Parameters
Name	Description
request	ListAuditReportsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListAuditReportsResponse	The call object.

ListAuditReportsAsync(ListAuditReportsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAuditReportsResponse> ListAuditReportsAsync(ListAuditReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists audit reports in the selected parent scope

Parameters
Name	Description
request	ListAuditReportsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListAuditReportsResponse	The call object.

ListControls(ListControlsRequest, CallOptions)

public virtual ListControlsResponse ListControls(ListControlsRequest request, CallOptions options)

Gets controls needed to be implemented to be compliant to a standard.

Parameters
Name	Description
request	ListControlsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListControlsResponse	The response received from the server.

ListControls(ListControlsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListControlsResponse ListControls(ListControlsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets controls needed to be implemented to be compliant to a standard.

Parameters
Name	Description
request	ListControlsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListControlsResponse	The response received from the server.

ListControlsAsync(ListControlsRequest, CallOptions)

public virtual AsyncUnaryCall<ListControlsResponse> ListControlsAsync(ListControlsRequest request, CallOptions options)

Gets controls needed to be implemented to be compliant to a standard.

Parameters
Name	Description
request	ListControlsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListControlsResponse	The call object.

ListControlsAsync(ListControlsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListControlsResponse> ListControlsAsync(ListControlsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets controls needed to be implemented to be compliant to a standard.

Parameters
Name	Description
request	ListControlsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListControlsResponse	The call object.

ListResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest, CallOptions)

public virtual ListResourceEnrollmentStatusesResponse ListResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest request, CallOptions options)

Fetches all resources under the parent along with their enrollment.

Parameters
Name	Description
request	ListResourceEnrollmentStatusesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListResourceEnrollmentStatusesResponse	The response received from the server.

ListResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListResourceEnrollmentStatusesResponse ListResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Fetches all resources under the parent along with their enrollment.

Parameters
Name	Description
request	ListResourceEnrollmentStatusesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListResourceEnrollmentStatusesResponse	The response received from the server.

ListResourceEnrollmentStatusesAsync(ListResourceEnrollmentStatusesRequest, CallOptions)

public virtual AsyncUnaryCall<ListResourceEnrollmentStatusesResponse> ListResourceEnrollmentStatusesAsync(ListResourceEnrollmentStatusesRequest request, CallOptions options)

Fetches all resources under the parent along with their enrollment.

Parameters
Name	Description
request	ListResourceEnrollmentStatusesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListResourceEnrollmentStatusesResponse	The call object.

ListResourceEnrollmentStatusesAsync(ListResourceEnrollmentStatusesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListResourceEnrollmentStatusesResponse> ListResourceEnrollmentStatusesAsync(ListResourceEnrollmentStatusesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Fetches all resources under the parent along with their enrollment.

Parameters
Name	Description
request	ListResourceEnrollmentStatusesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListResourceEnrollmentStatusesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override AuditManager.AuditManagerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
AuditManagerAuditManagerClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.AuditManager.V1.AuditManager.AuditManagerClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)