public sealed class SnoozeServiceClientImpl : SnoozeServiceClient
Reference documentation and code samples for the Google Cloud Monitoring v3 API class SnoozeServiceClientImpl.
SnoozeService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Monitoring.V3Assembly
Google.Cloud.Monitoring.V3.dll
Remarks
The SnoozeService API is used to temporarily prevent an alert policy from generating alerts. A Snooze is a description of the criteria under which one or more alert policies should not fire alerts for the specified duration.
Constructors
SnoozeServiceClientImpl(SnoozeServiceClient, SnoozeServiceSettings, ILogger)
public SnoozeServiceClientImpl(SnoozeService.SnoozeServiceClient grpcClient, SnoozeServiceSettings settings, ILogger logger)
Constructs a client wrapper for the SnoozeService service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient |
SnoozeServiceSnoozeServiceClient The underlying gRPC client. |
settings |
SnoozeServiceSettings The base SnoozeServiceSettings used within this client. |
logger |
ILogger Optional ILogger to use within this client. |
Properties
GrpcClient
public override SnoozeService.SnoozeServiceClient GrpcClient { get; }
The underlying gRPC SnoozeService client
Property Value | |
---|---|
Type | Description |
SnoozeServiceSnoozeServiceClient |
Methods
CreateSnooze(CreateSnoozeRequest, CallSettings)
public override Snooze CreateSnooze(CreateSnoozeRequest request, CallSettings callSettings = null)
Creates a Snooze
that will prevent alerts, which match the provided
criteria, from being opened. The Snooze
applies for a specific time
interval.
Parameters | |
---|---|
Name | Description |
request |
CreateSnoozeRequest 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 |
Snooze |
The RPC response. |
CreateSnoozeAsync(CreateSnoozeRequest, CallSettings)
public override Task<Snooze> CreateSnoozeAsync(CreateSnoozeRequest request, CallSettings callSettings = null)
Creates a Snooze
that will prevent alerts, which match the provided
criteria, from being opened. The Snooze
applies for a specific time
interval.
Parameters | |
---|---|
Name | Description |
request |
CreateSnoozeRequest 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 |
TaskSnooze |
A Task containing the RPC response. |
GetSnooze(GetSnoozeRequest, CallSettings)
public override Snooze GetSnooze(GetSnoozeRequest request, CallSettings callSettings = null)
Retrieves a Snooze
by name
.
Parameters | |
---|---|
Name | Description |
request |
GetSnoozeRequest 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 |
Snooze |
The RPC response. |
GetSnoozeAsync(GetSnoozeRequest, CallSettings)
public override Task<Snooze> GetSnoozeAsync(GetSnoozeRequest request, CallSettings callSettings = null)
Retrieves a Snooze
by name
.
Parameters | |
---|---|
Name | Description |
request |
GetSnoozeRequest 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 |
TaskSnooze |
A Task containing the RPC response. |
ListSnoozes(ListSnoozesRequest, CallSettings)
public override PagedEnumerable<ListSnoozesResponse, Snooze> ListSnoozes(ListSnoozesRequest request, CallSettings callSettings = null)
Lists the Snooze
s associated with a project. Can optionally pass in
filter
, which specifies predicates to match Snooze
s.
Parameters | |
---|---|
Name | Description |
request |
ListSnoozesRequest 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 |
PagedEnumerableListSnoozesResponseSnooze |
A pageable sequence of Snooze resources. |
ListSnoozesAsync(ListSnoozesRequest, CallSettings)
public override PagedAsyncEnumerable<ListSnoozesResponse, Snooze> ListSnoozesAsync(ListSnoozesRequest request, CallSettings callSettings = null)
Lists the Snooze
s associated with a project. Can optionally pass in
filter
, which specifies predicates to match Snooze
s.
Parameters | |
---|---|
Name | Description |
request |
ListSnoozesRequest 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 |
PagedAsyncEnumerableListSnoozesResponseSnooze |
A pageable asynchronous sequence of Snooze resources. |
UpdateSnooze(UpdateSnoozeRequest, CallSettings)
public override Snooze UpdateSnooze(UpdateSnoozeRequest request, CallSettings callSettings = null)
Updates a Snooze
, identified by its name
, with the parameters in the
given Snooze
object.
Parameters | |
---|---|
Name | Description |
request |
UpdateSnoozeRequest 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 |
Snooze |
The RPC response. |
UpdateSnoozeAsync(UpdateSnoozeRequest, CallSettings)
public override Task<Snooze> UpdateSnoozeAsync(UpdateSnoozeRequest request, CallSettings callSettings = null)
Updates a Snooze
, identified by its name
, with the parameters in the
given Snooze
object.
Parameters | |
---|---|
Name | Description |
request |
UpdateSnoozeRequest 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 |
TaskSnooze |
A Task containing the RPC response. |