Cloud Security Compliance v1 API - Class Monitoring.MonitoringClient (1.0.0-beta04)

public class Monitoring.MonitoringClient : ClientBase<Monitoring.MonitoringClient>

Reference documentation and code samples for the Cloud Security Compliance v1 API class Monitoring.MonitoringClient.

Client for Monitoring

Inheritance

object > ClientBase > ClientBaseMonitoringMonitoringClient > Monitoring.MonitoringClient

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

MonitoringClient()

protected MonitoringClient()

Protected parameterless constructor to allow creation of test doubles.

MonitoringClient(CallInvoker)

public MonitoringClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

MonitoringClient(ChannelBase)

public MonitoringClient(ChannelBase channel)

Creates a new client for Monitoring

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

MonitoringClient(ClientBaseConfiguration)

protected MonitoringClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregateFrameworkComplianceReport(AggregateFrameworkComplianceReportRequest, CallOptions)

public virtual AggregateFrameworkComplianceReportResponse AggregateFrameworkComplianceReport(AggregateFrameworkComplianceReportRequest request, CallOptions options)

Gets the aggregated compliance report over time for a given scope.

Parameters
Name Description
request AggregateFrameworkComplianceReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AggregateFrameworkComplianceReportResponse

The response received from the server.

AggregateFrameworkComplianceReport(AggregateFrameworkComplianceReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AggregateFrameworkComplianceReportResponse AggregateFrameworkComplianceReport(AggregateFrameworkComplianceReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the aggregated compliance report over time for a given scope.

Parameters
Name Description
request AggregateFrameworkComplianceReportRequest

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
AggregateFrameworkComplianceReportResponse

The response received from the server.

AggregateFrameworkComplianceReportAsync(AggregateFrameworkComplianceReportRequest, CallOptions)

public virtual AsyncUnaryCall<AggregateFrameworkComplianceReportResponse> AggregateFrameworkComplianceReportAsync(AggregateFrameworkComplianceReportRequest request, CallOptions options)

Gets the aggregated compliance report over time for a given scope.

Parameters
Name Description
request AggregateFrameworkComplianceReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAggregateFrameworkComplianceReportResponse

The call object.

AggregateFrameworkComplianceReportAsync(AggregateFrameworkComplianceReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AggregateFrameworkComplianceReportResponse> AggregateFrameworkComplianceReportAsync(AggregateFrameworkComplianceReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the aggregated compliance report over time for a given scope.

Parameters
Name Description
request AggregateFrameworkComplianceReportRequest

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
AsyncUnaryCallAggregateFrameworkComplianceReportResponse

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.

FetchFrameworkComplianceReport(FetchFrameworkComplianceReportRequest, CallOptions)

public virtual FrameworkComplianceReport FetchFrameworkComplianceReport(FetchFrameworkComplianceReportRequest request, CallOptions options)

Fetches the framework compliance report for a given scope.

Parameters
Name Description
request FetchFrameworkComplianceReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
FrameworkComplianceReport

The response received from the server.

FetchFrameworkComplianceReport(FetchFrameworkComplianceReportRequest, Metadata, DateTime?, CancellationToken)

public virtual FrameworkComplianceReport FetchFrameworkComplianceReport(FetchFrameworkComplianceReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Fetches the framework compliance report for a given scope.

Parameters
Name Description
request FetchFrameworkComplianceReportRequest

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
FrameworkComplianceReport

The response received from the server.

FetchFrameworkComplianceReportAsync(FetchFrameworkComplianceReportRequest, CallOptions)

public virtual AsyncUnaryCall<FrameworkComplianceReport> FetchFrameworkComplianceReportAsync(FetchFrameworkComplianceReportRequest request, CallOptions options)

Fetches the framework compliance report for a given scope.

Parameters
Name Description
request FetchFrameworkComplianceReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallFrameworkComplianceReport

The call object.

FetchFrameworkComplianceReportAsync(FetchFrameworkComplianceReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FrameworkComplianceReport> FetchFrameworkComplianceReportAsync(FetchFrameworkComplianceReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Fetches the framework compliance report for a given scope.

Parameters
Name Description
request FetchFrameworkComplianceReportRequest

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
AsyncUnaryCallFrameworkComplianceReport

The call object.

ListControlComplianceSummaries(ListControlComplianceSummariesRequest, CallOptions)

public virtual ListControlComplianceSummariesResponse ListControlComplianceSummaries(ListControlComplianceSummariesRequest request, CallOptions options)

Lists the control compliance summary for a given scope.

Parameters
Name Description
request ListControlComplianceSummariesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListControlComplianceSummariesResponse

The response received from the server.

ListControlComplianceSummaries(ListControlComplianceSummariesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListControlComplianceSummariesResponse ListControlComplianceSummaries(ListControlComplianceSummariesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the control compliance summary for a given scope.

Parameters
Name Description
request ListControlComplianceSummariesRequest

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
ListControlComplianceSummariesResponse

The response received from the server.

ListControlComplianceSummariesAsync(ListControlComplianceSummariesRequest, CallOptions)

public virtual AsyncUnaryCall<ListControlComplianceSummariesResponse> ListControlComplianceSummariesAsync(ListControlComplianceSummariesRequest request, CallOptions options)

Lists the control compliance summary for a given scope.

Parameters
Name Description
request ListControlComplianceSummariesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListControlComplianceSummariesResponse

The call object.

ListControlComplianceSummariesAsync(ListControlComplianceSummariesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListControlComplianceSummariesResponse> ListControlComplianceSummariesAsync(ListControlComplianceSummariesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the control compliance summary for a given scope.

Parameters
Name Description
request ListControlComplianceSummariesRequest

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
AsyncUnaryCallListControlComplianceSummariesResponse

The call object.

ListFindingSummaries(ListFindingSummariesRequest, CallOptions)

public virtual ListFindingSummariesResponse ListFindingSummaries(ListFindingSummariesRequest request, CallOptions options)

Lists the finding summary by category for a given scope.

Parameters
Name Description
request ListFindingSummariesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListFindingSummariesResponse

The response received from the server.

ListFindingSummaries(ListFindingSummariesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFindingSummariesResponse ListFindingSummaries(ListFindingSummariesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the finding summary by category for a given scope.

Parameters
Name Description
request ListFindingSummariesRequest

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
ListFindingSummariesResponse

The response received from the server.

ListFindingSummariesAsync(ListFindingSummariesRequest, CallOptions)

public virtual AsyncUnaryCall<ListFindingSummariesResponse> ListFindingSummariesAsync(ListFindingSummariesRequest request, CallOptions options)

Lists the finding summary by category for a given scope.

Parameters
Name Description
request ListFindingSummariesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListFindingSummariesResponse

The call object.

ListFindingSummariesAsync(ListFindingSummariesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFindingSummariesResponse> ListFindingSummariesAsync(ListFindingSummariesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the finding summary by category for a given scope.

Parameters
Name Description
request ListFindingSummariesRequest

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
AsyncUnaryCallListFindingSummariesResponse

The call object.

ListFrameworkComplianceSummaries(ListFrameworkComplianceSummariesRequest, CallOptions)

public virtual ListFrameworkComplianceSummariesResponse ListFrameworkComplianceSummaries(ListFrameworkComplianceSummariesRequest request, CallOptions options)

Lists the framework compliance summary for a given scope.

Parameters
Name Description
request ListFrameworkComplianceSummariesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListFrameworkComplianceSummariesResponse

The response received from the server.

ListFrameworkComplianceSummaries(ListFrameworkComplianceSummariesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFrameworkComplianceSummariesResponse ListFrameworkComplianceSummaries(ListFrameworkComplianceSummariesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the framework compliance summary for a given scope.

Parameters
Name Description
request ListFrameworkComplianceSummariesRequest

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
ListFrameworkComplianceSummariesResponse

The response received from the server.

ListFrameworkComplianceSummariesAsync(ListFrameworkComplianceSummariesRequest, CallOptions)

public virtual AsyncUnaryCall<ListFrameworkComplianceSummariesResponse> ListFrameworkComplianceSummariesAsync(ListFrameworkComplianceSummariesRequest request, CallOptions options)

Lists the framework compliance summary for a given scope.

Parameters
Name Description
request ListFrameworkComplianceSummariesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListFrameworkComplianceSummariesResponse

The call object.

ListFrameworkComplianceSummariesAsync(ListFrameworkComplianceSummariesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFrameworkComplianceSummariesResponse> ListFrameworkComplianceSummariesAsync(ListFrameworkComplianceSummariesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the framework compliance summary for a given scope.

Parameters
Name Description
request ListFrameworkComplianceSummariesRequest

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
AsyncUnaryCallListFrameworkComplianceSummariesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override Monitoring.MonitoringClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
MonitoringMonitoringClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.CloudSecurityCompliance.V1.Monitoring.MonitoringClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)