Class SnoozeServiceClient (3.33.0)

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.

Inheritance

java.lang.Object > SnoozeServiceClient

Static Methods

create()

public static final SnoozeServiceClient create()

Constructs an instance of SnoozeServiceClient with default settings.

Returns
Type	Description
`SnoozeServiceClient`

Exceptions
Type	Description
`IOException`

create(SnoozeServiceSettings settings)

public static final SnoozeServiceClient create(SnoozeServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`SnoozeServiceSettings`

Returns
Type	Description
`SnoozeServiceClient`

Exceptions
Type	Description
`IOException`

create(SnoozeServiceStub stub)

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).

Parameter
Name	Description
`stub`	`SnoozeServiceStub`

Returns
Type	Description
`SnoozeServiceClient`

Constructors

SnoozeServiceClient(SnoozeServiceSettings settings)

protected SnoozeServiceClient(SnoozeServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`SnoozeServiceSettings`

SnoozeServiceClient(SnoozeServiceStub stub)

protected SnoozeServiceClient(SnoozeServiceStub stub)

Parameter
Name	Description
`stub`	`SnoozeServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createSnooze(CreateSnoozeRequest request)

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);
 }

Parameter
Name	Description
`request`	`CreateSnoozeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Snooze`

createSnooze(ProjectName parent, Snooze snooze)

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

Name Description

parent

ProjectName

Required. The project in which a Snooze should be created. The format is:

projects/[PROJECT_ID_OR_NUMBER]

snooze

Snooze

Required. The Snooze to create. Omit the name field, as it will be filled in by the API.

Returns
Type	Description
`Snooze`

createSnooze(String parent, Snooze snooze)

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

Name Description

parent

String

Required. The project in which a Snooze should be created. The format is:

projects/[PROJECT_ID_OR_NUMBER]

snooze

Snooze

Required. The Snooze to create. Omit the name field, as it will be filled in by the API.

Returns
Type	Description
`Snooze`

createSnoozeCallable()

public final 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();
 }

Returns
Type	Description
`UnaryCallable<CreateSnoozeRequest,Snooze>`

getSettings()

public final SnoozeServiceSettings getSettings()

Returns
Type	Description
`SnoozeServiceSettings`

getSnooze(GetSnoozeRequest request)

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);
 }

Parameter
Name	Description
`request`	`GetSnoozeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Snooze`

getSnooze(SnoozeName name)

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);
 }

Parameter

Name Description

name

SnoozeName

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

projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

Returns
Type	Description
`Snooze`

getSnooze(String name)

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);
 }

Parameter

Name Description

name

String

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

projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

Returns
Type	Description
`Snooze`

getSnoozeCallable()

public final 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();
 }

Returns
Type	Description
`UnaryCallable<GetSnoozeRequest,Snooze>`

getStub()

public SnoozeServiceStub getStub()

Returns
Type	Description
`SnoozeServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listSnoozes(ListSnoozesRequest request)

public final SnoozeServiceClient.ListSnoozesPagedResponse listSnoozes(ListSnoozesRequest request)

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

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);
   }
 }

Parameter
Name	Description
`request`	`ListSnoozesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`SnoozeServiceClient.ListSnoozesPagedResponse`

listSnoozes(ProjectName parent)

public final SnoozeServiceClient.ListSnoozesPagedResponse listSnoozes(ProjectName parent)

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

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);
   }
 }

Parameter

Name Description

parent

ProjectName

Required. The project whose Snoozes should be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Returns
Type	Description
`SnoozeServiceClient.ListSnoozesPagedResponse`

listSnoozes(String parent)

public final SnoozeServiceClient.ListSnoozesPagedResponse listSnoozes(String parent)

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

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);
   }
 }

Parameter

Name Description

parent

String

Required. The project whose Snoozes should be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Returns
Type	Description
`SnoozeServiceClient.ListSnoozesPagedResponse`

listSnoozesCallable()

public final UnaryCallable<ListSnoozesRequest,ListSnoozesResponse> listSnoozesCallable()

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

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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListSnoozesRequest,ListSnoozesResponse>`

listSnoozesPagedCallable()

public final UnaryCallable<ListSnoozesRequest,SnoozeServiceClient.ListSnoozesPagedResponse> listSnoozesPagedCallable()

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

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);
   }
 }

Returns
Type	Description
`UnaryCallable<ListSnoozesRequest,ListSnoozesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateSnooze(Snooze snooze, FieldMask updateMask)

public final Snooze updateSnooze(Snooze snooze, 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

Name Description

snooze

Snooze

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

updateMask

FieldMask

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.

Returns
Type	Description
`Snooze`

updateSnooze(UpdateSnoozeRequest request)

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);
 }

Parameter
Name	Description
`request`	`UpdateSnoozeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Snooze`

updateSnoozeCallable()

public final 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();
 }

Returns
Type	Description
`UnaryCallable<UpdateSnoozeRequest,Snooze>`