java.lang.Object
- com.google.cloud.monitoring.v3.SnoozeServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated("by gapic-generator-java")
public class SnoozeServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SnoozeServiceClient snoozeServiceClient = SnoozeServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Snooze snooze = Snooze.newBuilder().build();
   Snooze response = snoozeServiceClient.createSnooze(parent, snooze);
 }

Note: close() needs to be called on the SnoozeServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of SnoozeServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SnoozeServiceSettings snoozeServiceSettings =
     SnoozeServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SnoozeServiceClient snoozeServiceClient = SnoozeServiceClient.create(snoozeServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SnoozeServiceSettings snoozeServiceSettings =
     SnoozeServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SnoozeServiceClient snoozeServiceClient = SnoozeServiceClient.create(snoozeServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SnoozeServiceClient.ListSnoozesFixedSizeCollection`
`static class`	`SnoozeServiceClient.ListSnoozesPage`
`static class`	`SnoozeServiceClient.ListSnoozesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`SnoozeServiceClient(SnoozeServiceSettings settings)`	Constructs an instance of SnoozeServiceClient, using the given settings.
`protected`	`SnoozeServiceClient(SnoozeServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SnoozeServiceClient`	`create()`	Constructs an instance of SnoozeServiceClient with default settings.
`static SnoozeServiceClient`	`create(SnoozeServiceSettings settings)`	Constructs an instance of SnoozeServiceClient, using the given settings.
`static SnoozeServiceClient`	`create(SnoozeServiceStub stub)`	Constructs an instance of SnoozeServiceClient, using the given stub for making calls.
`Snooze`	`createSnooze(CreateSnoozeRequest request)`	Creates a `Snooze` that will prevent alerts, which match the provided criteria, from being opened.
`Snooze`	`createSnooze(ProjectName parent, Snooze snooze)`	Creates a `Snooze` that will prevent alerts, which match the provided criteria, from being opened.
`Snooze`	`createSnooze(String parent, Snooze snooze)`	Creates a `Snooze` that will prevent alerts, which match the provided criteria, from being opened.
`com.google.api.gax.rpc.UnaryCallable<CreateSnoozeRequest,Snooze>`	`createSnoozeCallable()`	Creates a `Snooze` that will prevent alerts, which match the provided criteria, from being opened.
`SnoozeServiceSettings`	`getSettings()`
`Snooze`	`getSnooze(GetSnoozeRequest request)`	Retrieves a `Snooze` by `name`.
`Snooze`	`getSnooze(SnoozeName name)`	Retrieves a `Snooze` by `name`.
`Snooze`	`getSnooze(String name)`	Retrieves a `Snooze` by `name`.
`com.google.api.gax.rpc.UnaryCallable<GetSnoozeRequest,Snooze>`	`getSnoozeCallable()`	Retrieves a `Snooze` by `name`.
`SnoozeServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SnoozeServiceClient.ListSnoozesPagedResponse`	`listSnoozes(ListSnoozesRequest request)`	Lists the `Snooze`s associated with a project.
`SnoozeServiceClient.ListSnoozesPagedResponse`	`listSnoozes(ProjectName parent)`	Lists the `Snooze`s associated with a project.
`SnoozeServiceClient.ListSnoozesPagedResponse`	`listSnoozes(String parent)`	Lists the `Snooze`s associated with a project.
`com.google.api.gax.rpc.UnaryCallable<ListSnoozesRequest,ListSnoozesResponse>`	`listSnoozesCallable()`	Lists the `Snooze`s associated with a project.
`com.google.api.gax.rpc.UnaryCallable<ListSnoozesRequest,SnoozeServiceClient.ListSnoozesPagedResponse>`	`listSnoozesPagedCallable()`	Lists the `Snooze`s associated with a project.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Snooze`	`updateSnooze(Snooze snooze, com.google.protobuf.FieldMask updateMask)`	Updates a `Snooze`, identified by its `name`, with the parameters in the given `Snooze` object.
`Snooze`	`updateSnooze(UpdateSnoozeRequest request)`	Updates a `Snooze`, identified by its `name`, with the parameters in the given `Snooze` object.
`com.google.api.gax.rpc.UnaryCallable<UpdateSnoozeRequest,Snooze>`	`updateSnoozeCallable()`	Updates a `Snooze`, identified by its `name`, with the parameters in the given `Snooze` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SnoozeServiceClient
```
protected SnoozeServiceClient(SnoozeServiceSettings settings)
                       throws IOException
```
  Constructs an instance of SnoozeServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- SnoozeServiceClient
```
protected SnoozeServiceClient(SnoozeServiceStub stub)
```

Method Detail

create

public static final SnoozeServiceClient create()
                                        throws IOException

Constructs an instance of SnoozeServiceClient with default settings.

Throws:: IOException

create
```
public static final SnoozeServiceClient create(SnoozeServiceSettings settings)
                                        throws IOException
```
Constructs an instance of SnoozeServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final SnoozeServiceClient create(SnoozeServiceStub stub)
```
Constructs an instance of SnoozeServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SnoozeServiceSettings).

getSettings

public final SnoozeServiceSettings getSettings()

getStub
```
public SnoozeServiceStub getStub()
```

createSnooze

public final Snooze createSnooze(ProjectName parent,
                                 Snooze snooze)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SnoozeServiceClient snoozeServiceClient = SnoozeServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Snooze snooze = Snooze.newBuilder().build();
   Snooze response = snoozeServiceClient.createSnooze(parent, snooze);
 }

Parameters:: parent - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which a `Snooze` should be created. The format is:
projects/[PROJECT_ID_OR_NUMBER]; snooze - Required. The `Snooze` to create. Omit the `name` field, as it will be filled in by the API.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createSnooze

public final Snooze createSnooze(String parent,
                                 Snooze snooze)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SnoozeServiceClient snoozeServiceClient = SnoozeServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Snooze snooze = Snooze.newBuilder().build();
   Snooze response = snoozeServiceClient.createSnooze(parent, snooze);
 }

Parameters:: parent - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which a `Snooze` should be created. The format is:
projects/[PROJECT_ID_OR_NUMBER]; snooze - Required. The `Snooze` to create. Omit the `name` field, as it will be filled in by the API.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createSnooze

public final Snooze createSnooze(CreateSnoozeRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SnoozeServiceClient snoozeServiceClient = SnoozeServiceClient.create()) {
   CreateSnoozeRequest request =
       CreateSnoozeRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setSnooze(Snooze.newBuilder().build())
           .build();
   Snooze response = snoozeServiceClient.createSnooze(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createSnoozeCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateSnoozeRequest,Snooze> createSnoozeCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SnoozeServiceClient snoozeServiceClient = SnoozeServiceClient.create()) {
   CreateSnoozeRequest request =
       CreateSnoozeRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setSnooze(Snooze.newBuilder().build())
           .build();
   ApiFuture<Snooze> future = snoozeServiceClient.createSnoozeCallable().futureCall(request);
   // Do something.
   Snooze response = future.get();
 }