Google Cloud Monitoring v3 API - Class SnoozeService.SnoozeServiceClient (3.5.0)

public class SnoozeService.SnoozeServiceClient : ClientBase<SnoozeService.SnoozeServiceClient>

Reference documentation and code samples for the Google Cloud Monitoring v3 API class SnoozeService.SnoozeServiceClient.

Client for SnoozeService

Inheritance

object > ClientBase > ClientBaseSnoozeServiceSnoozeServiceClient > SnoozeService.SnoozeServiceClient

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

SnoozeServiceClient()

protected SnoozeServiceClient()

Protected parameterless constructor to allow creation of test doubles.

SnoozeServiceClient(CallInvoker)

public SnoozeServiceClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

SnoozeServiceClient(ChannelBase)

public SnoozeServiceClient(ChannelBase channel)

Creates a new client for SnoozeService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

SnoozeServiceClient(ClientBaseConfiguration)

protected SnoozeServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateSnooze(CreateSnoozeRequest, CallOptions)

public virtual Snooze CreateSnooze(CreateSnoozeRequest request, CallOptions options)

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.

Parameters
NameDescription
requestCreateSnoozeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Snooze

The response received from the server.

CreateSnooze(CreateSnoozeRequest, Metadata, DateTime?, CancellationToken)

public virtual Snooze CreateSnooze(CreateSnoozeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.

Parameters
NameDescription
requestCreateSnoozeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Snooze

The response received from the server.

CreateSnoozeAsync(CreateSnoozeRequest, CallOptions)

public virtual AsyncUnaryCall<Snooze> CreateSnoozeAsync(CreateSnoozeRequest request, CallOptions options)

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.

Parameters
NameDescription
requestCreateSnoozeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSnooze

The call object.

CreateSnoozeAsync(CreateSnoozeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Snooze> CreateSnoozeAsync(CreateSnoozeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.

Parameters
NameDescription
requestCreateSnoozeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallSnooze

The call object.

GetSnooze(GetSnoozeRequest, CallOptions)

public virtual Snooze GetSnooze(GetSnoozeRequest request, CallOptions options)

Retrieves a Snooze by name.

Parameters
NameDescription
requestGetSnoozeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Snooze

The response received from the server.

GetSnooze(GetSnoozeRequest, Metadata, DateTime?, CancellationToken)

public virtual Snooze GetSnooze(GetSnoozeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a Snooze by name.

Parameters
NameDescription
requestGetSnoozeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Snooze

The response received from the server.

GetSnoozeAsync(GetSnoozeRequest, CallOptions)

public virtual AsyncUnaryCall<Snooze> GetSnoozeAsync(GetSnoozeRequest request, CallOptions options)

Retrieves a Snooze by name.

Parameters
NameDescription
requestGetSnoozeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSnooze

The call object.

GetSnoozeAsync(GetSnoozeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Snooze> GetSnoozeAsync(GetSnoozeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a Snooze by name.

Parameters
NameDescription
requestGetSnoozeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallSnooze

The call object.

ListSnoozes(ListSnoozesRequest, CallOptions)

public virtual ListSnoozesResponse ListSnoozes(ListSnoozesRequest request, CallOptions options)

Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.

Parameters
NameDescription
requestListSnoozesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListSnoozesResponse

The response received from the server.

ListSnoozes(ListSnoozesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSnoozesResponse ListSnoozes(ListSnoozesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.

Parameters
NameDescription
requestListSnoozesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListSnoozesResponse

The response received from the server.

ListSnoozesAsync(ListSnoozesRequest, CallOptions)

public virtual AsyncUnaryCall<ListSnoozesResponse> ListSnoozesAsync(ListSnoozesRequest request, CallOptions options)

Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.

Parameters
NameDescription
requestListSnoozesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListSnoozesResponse

The call object.

ListSnoozesAsync(ListSnoozesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSnoozesResponse> ListSnoozesAsync(ListSnoozesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.

Parameters
NameDescription
requestListSnoozesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListSnoozesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override SnoozeService.SnoozeServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
SnoozeServiceSnoozeServiceClient
Overrides

UpdateSnooze(UpdateSnoozeRequest, CallOptions)

public virtual Snooze UpdateSnooze(UpdateSnoozeRequest request, CallOptions options)

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.

Parameters
NameDescription
requestUpdateSnoozeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Snooze

The response received from the server.

UpdateSnooze(UpdateSnoozeRequest, Metadata, DateTime?, CancellationToken)

public virtual Snooze UpdateSnooze(UpdateSnoozeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.

Parameters
NameDescription
requestUpdateSnoozeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Snooze

The response received from the server.

UpdateSnoozeAsync(UpdateSnoozeRequest, CallOptions)

public virtual AsyncUnaryCall<Snooze> UpdateSnoozeAsync(UpdateSnoozeRequest request, CallOptions options)

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.

Parameters
NameDescription
requestUpdateSnoozeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSnooze

The call object.

UpdateSnoozeAsync(UpdateSnoozeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Snooze> UpdateSnoozeAsync(UpdateSnoozeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.

Parameters
NameDescription
requestUpdateSnoozeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallSnooze

The call object.