Cloud Security Compliance v1 API - Class Audit.AuditClient (1.0.0-beta04)

public class Audit.AuditClient : ClientBase<Audit.AuditClient>

Reference documentation and code samples for the Cloud Security Compliance v1 API class Audit.AuditClient.

Client for Audit

Inheritance

object > ClientBase > ClientBaseAuditAuditClient > Audit.AuditClient

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

AuditClient()

protected AuditClient()

Protected parameterless constructor to allow creation of test doubles.

AuditClient(CallInvoker)

public AuditClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

AuditClient(ChannelBase)

public AuditClient(ChannelBase channel)

Creates a new client for Audit

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

AuditClient(ClientBaseConfiguration)

protected AuditClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateFrameworkAudit(CreateFrameworkAuditRequest, CallOptions)

public virtual Operation CreateFrameworkAudit(CreateFrameworkAuditRequest request, CallOptions options)

Creates an audit scope report for a framework.

Parameters
Name Description
request CreateFrameworkAuditRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateFrameworkAudit(CreateFrameworkAuditRequest, Metadata, DateTime?, CancellationToken)

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

Creates an audit scope report for a framework.

Parameters
Name Description
request CreateFrameworkAuditRequest

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.

CreateFrameworkAuditAsync(CreateFrameworkAuditRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateFrameworkAuditAsync(CreateFrameworkAuditRequest request, CallOptions options)

Creates an audit scope report for a framework.

Parameters
Name Description
request CreateFrameworkAuditRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateFrameworkAuditAsync(CreateFrameworkAuditRequest, Metadata, DateTime?, CancellationToken)

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

Creates an audit scope report for a framework.

Parameters
Name Description
request CreateFrameworkAuditRequest

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.

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.

GenerateFrameworkAuditScopeReport(GenerateFrameworkAuditScopeReportRequest, CallOptions)

public virtual GenerateFrameworkAuditScopeReportResponse GenerateFrameworkAuditScopeReport(GenerateFrameworkAuditScopeReportRequest request, CallOptions options)

Generates an audit scope report for a framework.

Parameters
Name Description
request GenerateFrameworkAuditScopeReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
GenerateFrameworkAuditScopeReportResponse

The response received from the server.

GenerateFrameworkAuditScopeReport(GenerateFrameworkAuditScopeReportRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateFrameworkAuditScopeReportResponse GenerateFrameworkAuditScopeReport(GenerateFrameworkAuditScopeReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates an audit scope report for a framework.

Parameters
Name Description
request GenerateFrameworkAuditScopeReportRequest

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
GenerateFrameworkAuditScopeReportResponse

The response received from the server.

GenerateFrameworkAuditScopeReportAsync(GenerateFrameworkAuditScopeReportRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateFrameworkAuditScopeReportResponse> GenerateFrameworkAuditScopeReportAsync(GenerateFrameworkAuditScopeReportRequest request, CallOptions options)

Generates an audit scope report for a framework.

Parameters
Name Description
request GenerateFrameworkAuditScopeReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallGenerateFrameworkAuditScopeReportResponse

The call object.

GenerateFrameworkAuditScopeReportAsync(GenerateFrameworkAuditScopeReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateFrameworkAuditScopeReportResponse> GenerateFrameworkAuditScopeReportAsync(GenerateFrameworkAuditScopeReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates an audit scope report for a framework.

Parameters
Name Description
request GenerateFrameworkAuditScopeReportRequest

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
AsyncUnaryCallGenerateFrameworkAuditScopeReportResponse

The call object.

GetFrameworkAudit(GetFrameworkAuditRequest, CallOptions)

public virtual FrameworkAudit GetFrameworkAudit(GetFrameworkAuditRequest request, CallOptions options)

Gets the details for a framework audit.

Parameters
Name Description
request GetFrameworkAuditRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
FrameworkAudit

The response received from the server.

GetFrameworkAudit(GetFrameworkAuditRequest, Metadata, DateTime?, CancellationToken)

public virtual FrameworkAudit GetFrameworkAudit(GetFrameworkAuditRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details for a framework audit.

Parameters
Name Description
request GetFrameworkAuditRequest

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
FrameworkAudit

The response received from the server.

GetFrameworkAuditAsync(GetFrameworkAuditRequest, CallOptions)

public virtual AsyncUnaryCall<FrameworkAudit> GetFrameworkAuditAsync(GetFrameworkAuditRequest request, CallOptions options)

Gets the details for a framework audit.

Parameters
Name Description
request GetFrameworkAuditRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallFrameworkAudit

The call object.

GetFrameworkAuditAsync(GetFrameworkAuditRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FrameworkAudit> GetFrameworkAuditAsync(GetFrameworkAuditRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details for a framework audit.

Parameters
Name Description
request GetFrameworkAuditRequest

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
AsyncUnaryCallFrameworkAudit

The call object.

ListFrameworkAudits(ListFrameworkAuditsRequest, CallOptions)

public virtual ListFrameworkAuditsResponse ListFrameworkAudits(ListFrameworkAuditsRequest request, CallOptions options)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
request ListFrameworkAuditsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListFrameworkAuditsResponse

The response received from the server.

ListFrameworkAudits(ListFrameworkAuditsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFrameworkAuditsResponse ListFrameworkAudits(ListFrameworkAuditsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
request ListFrameworkAuditsRequest

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
ListFrameworkAuditsResponse

The response received from the server.

ListFrameworkAuditsAsync(ListFrameworkAuditsRequest, CallOptions)

public virtual AsyncUnaryCall<ListFrameworkAuditsResponse> ListFrameworkAuditsAsync(ListFrameworkAuditsRequest request, CallOptions options)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
request ListFrameworkAuditsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListFrameworkAuditsResponse

The call object.

ListFrameworkAuditsAsync(ListFrameworkAuditsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFrameworkAuditsResponse> ListFrameworkAuditsAsync(ListFrameworkAuditsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
request ListFrameworkAuditsRequest

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
AsyncUnaryCallListFrameworkAuditsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override Audit.AuditClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
AuditAuditClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.CloudSecurityCompliance.V1.Audit.AuditClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)