com.google.cloud.monitoring.v3

Class SnoozeServiceClient

java.lang.Object

com.google.cloud.monitoring.v3.SnoozeServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="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:

1. 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.
2. 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.
3. 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 and Description
static class	SnoozeServiceClient.ListSnoozesFixedSizeCollection
static class	SnoozeServiceClient.ListSnoozesPage
static class	SnoozeServiceClient.ListSnoozesPagedResponse

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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();
 }
 

listSnoozes

public final SnoozeServiceClient.ListSnoozesPagedResponse listSnoozes(ProjectName parent)

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

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]");
   for (Snooze element : snoozeServiceClient.listSnoozes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose `Snooze`s should be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSnoozes

public final SnoozeServiceClient.ListSnoozesPagedResponse listSnoozes(String parent)

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

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();
   for (Snooze element : snoozeServiceClient.listSnoozes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose `Snooze`s should be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSnoozes

public final SnoozeServiceClient.ListSnoozesPagedResponse listSnoozes(ListSnoozesRequest request)

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

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()) {
   ListSnoozesRequest request =
       ListSnoozesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Snooze element : snoozeServiceClient.listSnoozes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listSnoozesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSnoozesRequest,SnoozeServiceClient.ListSnoozesPagedResponse> listSnoozesPagedCallable()

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

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()) {
   ListSnoozesRequest request =
       ListSnoozesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Snooze> future = snoozeServiceClient.listSnoozesPagedCallable().futureCall(request);
   // Do something.
   for (Snooze element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listSnoozesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSnoozesRequest,ListSnoozesResponse> listSnoozesCallable()

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

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()) {
   ListSnoozesRequest request =
       ListSnoozesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSnoozesResponse response = snoozeServiceClient.listSnoozesCallable().call(request);
     for (Snooze element : response.getSnoozesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getSnooze

public final Snooze getSnooze(SnoozeName name)

Retrieves a `Snooze` by `name`.

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()) {
   SnoozeName name = SnoozeName.of("[PROJECT]", "[SNOOZE]");
   Snooze response = snoozeServiceClient.getSnooze(name);
 }
 

Parameters:

name - Required. The ID of the `Snooze` to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSnooze

public final Snooze getSnooze(String name)

Retrieves a `Snooze` by `name`.

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 name = SnoozeName.of("[PROJECT]", "[SNOOZE]").toString();
   Snooze response = snoozeServiceClient.getSnooze(name);
 }
 

Parameters:

name - Required. The ID of the `Snooze` to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSnooze

public final Snooze getSnooze(GetSnoozeRequest request)

Retrieves a `Snooze` by `name`.

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()) {
   GetSnoozeRequest request =
       GetSnoozeRequest.newBuilder()
           .setName(SnoozeName.of("[PROJECT]", "[SNOOZE]").toString())
           .build();
   Snooze response = snoozeServiceClient.getSnooze(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

getSnoozeCallable

public final com.google.api.gax.rpc.UnaryCallable<GetSnoozeRequest,Snooze> getSnoozeCallable()

Retrieves a `Snooze` by `name`.

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()) {
   GetSnoozeRequest request =
       GetSnoozeRequest.newBuilder()
           .setName(SnoozeName.of("[PROJECT]", "[SNOOZE]").toString())
           .build();
   ApiFuture<Snooze> future = snoozeServiceClient.getSnoozeCallable().futureCall(request);
   // Do something.
   Snooze response = future.get();
 }
 

updateSnooze

public final Snooze updateSnooze(Snooze snooze,
                                 com.google.protobuf.FieldMask updateMask)

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

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()) {
   Snooze snooze = Snooze.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Snooze response = snoozeServiceClient.updateSnooze(snooze, updateMask);
 }
 

Parameters:

snooze - Required. The `Snooze` to update. Must have the name field present.

updateMask - Required. The fields to update.

For each field listed in `update_mask`:

* If the `Snooze` object supplied in the `UpdateSnoozeRequest` has a value for that field, the value of the field in the existing `Snooze` will be set to the value of the field in the supplied `Snooze`. * If the field does not have a value in the supplied `Snooze`, the field in the existing `Snooze` is set to its default value.

Fields not listed retain their existing value.

The following are the field names that are accepted in `update_mask`:

* `display_name` * `interval.start_time` * `interval.end_time`

That said, the start time and end time of the `Snooze` determines which fields can legally be updated. Before attempting an update, users should consult the documentation for `UpdateSnoozeRequest`, which talks about which fields can be updated.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateSnooze

public final Snooze updateSnooze(UpdateSnoozeRequest request)

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

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()) {
   UpdateSnoozeRequest request =
       UpdateSnoozeRequest.newBuilder()
           .setSnooze(Snooze.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Snooze response = snoozeServiceClient.updateSnooze(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

updateSnoozeCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateSnoozeRequest,Snooze> updateSnoozeCallable()

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

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()) {
   UpdateSnoozeRequest request =
       UpdateSnoozeRequest.newBuilder()
           .setSnooze(Snooze.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Snooze> future = snoozeServiceClient.updateSnoozeCallable().futureCall(request);
   // Do something.
   Snooze response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException