com.google.cloud.advisorynotifications.v1.AdvisoryNotificationsServiceClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-advisorynotifications Show documentation
Show all versions of google-cloud-advisorynotifications Show documentation
Advisory Notifications API An API for accessing Advisory Notifications in Google Cloud.
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.advisorynotifications.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.advisorynotifications.v1.stub.AdvisoryNotificationsServiceStub;
import com.google.cloud.advisorynotifications.v1.stub.AdvisoryNotificationsServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service to manage Security and Privacy Notifications.
*
* 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:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* NotificationName name =
* NotificationName.ofOrganizationLocationNotificationName(
* "[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]");
* Notification response = advisoryNotificationsServiceClient.getNotification(name);
* }
* }
*
* Note: close() needs to be called on the AdvisoryNotificationsServiceClient object to clean up
* resources such as threads. In the example above, try-with-resources is used, which automatically
* calls close().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* ListNotifications
Lists notifications under a given parent.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listNotifications(ListNotificationsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listNotifications(LocationName parent)
*
listNotifications(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listNotificationsPagedCallable()
*
listNotificationsCallable()
*
*
*
*
* GetNotification
Gets a notification.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getNotification(GetNotificationRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getNotification(NotificationName name)
*
getNotification(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getNotificationCallable()
*
*
*
*
* GetSettings
Get notification settings.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getSettings(GetSettingsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getSettings(SettingsName name)
*
getSettings(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getSettingsCallable()
*
*
*
*
* UpdateSettings
Update notification settings.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateSettings(UpdateSettingsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateSettings(Settings settings)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateSettingsCallable()
*
*
*
*
*
* 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
* AdvisoryNotificationsServiceSettings to create(). For example:
*
*
To customize credentials:
*
*
{@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
* AdvisoryNotificationsServiceSettings advisoryNotificationsServiceSettings =
* AdvisoryNotificationsServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create(advisoryNotificationsServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* AdvisoryNotificationsServiceSettings advisoryNotificationsServiceSettings =
* AdvisoryNotificationsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create(advisoryNotificationsServiceSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* AdvisoryNotificationsServiceSettings advisoryNotificationsServiceSettings =
* AdvisoryNotificationsServiceSettings.newHttpJsonBuilder().build();
* AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create(advisoryNotificationsServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class AdvisoryNotificationsServiceClient implements BackgroundResource {
private final AdvisoryNotificationsServiceSettings settings;
private final AdvisoryNotificationsServiceStub stub;
/** Constructs an instance of AdvisoryNotificationsServiceClient with default settings. */
public static final AdvisoryNotificationsServiceClient create() throws IOException {
return create(AdvisoryNotificationsServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of AdvisoryNotificationsServiceClient, using the given settings. The
* channels are created based on the settings passed in, or defaults for any settings that are not
* set.
*/
public static final AdvisoryNotificationsServiceClient create(
AdvisoryNotificationsServiceSettings settings) throws IOException {
return new AdvisoryNotificationsServiceClient(settings);
}
/**
* Constructs an instance of AdvisoryNotificationsServiceClient, using the given stub for making
* calls. This is for advanced usage - prefer using create(AdvisoryNotificationsServiceSettings).
*/
public static final AdvisoryNotificationsServiceClient create(
AdvisoryNotificationsServiceStub stub) {
return new AdvisoryNotificationsServiceClient(stub);
}
/**
* Constructs an instance of AdvisoryNotificationsServiceClient, 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.
*/
protected AdvisoryNotificationsServiceClient(AdvisoryNotificationsServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub =
((AdvisoryNotificationsServiceStubSettings) settings.getStubSettings()).createStub();
}
protected AdvisoryNotificationsServiceClient(AdvisoryNotificationsServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final AdvisoryNotificationsServiceSettings getSettings() {
return settings;
}
public AdvisoryNotificationsServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists notifications under a given parent.
*
*
Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* LocationName parent = LocationName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]");
* for (Notification element :
* advisoryNotificationsServiceClient.listNotifications(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of notifications. Must be of the
* form "organizations/{organization}/locations/{location}" or
* "projects/{project}/locations/{location}".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListNotificationsPagedResponse listNotifications(LocationName parent) {
ListNotificationsRequest request =
ListNotificationsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listNotifications(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists notifications under a given parent.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* String parent =
* LocationName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]").toString();
* for (Notification element :
* advisoryNotificationsServiceClient.listNotifications(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of notifications. Must be of the
* form "organizations/{organization}/locations/{location}" or
* "projects/{project}/locations/{location}".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListNotificationsPagedResponse listNotifications(String parent) {
ListNotificationsRequest request =
ListNotificationsRequest.newBuilder().setParent(parent).build();
return listNotifications(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists notifications under a given parent.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* ListNotificationsRequest request =
* ListNotificationsRequest.newBuilder()
* .setParent(
* LocationName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setView(NotificationView.forNumber(0))
* .setLanguageCode("languageCode-2092349083")
* .build();
* for (Notification element :
* advisoryNotificationsServiceClient.listNotifications(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListNotificationsPagedResponse listNotifications(ListNotificationsRequest request) {
return listNotificationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists notifications under a given parent.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* ListNotificationsRequest request =
* ListNotificationsRequest.newBuilder()
* .setParent(
* LocationName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setView(NotificationView.forNumber(0))
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* advisoryNotificationsServiceClient.listNotificationsPagedCallable().futureCall(request);
* // Do something.
* for (Notification element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listNotificationsPagedCallable() {
return stub.listNotificationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists notifications under a given parent.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* ListNotificationsRequest request =
* ListNotificationsRequest.newBuilder()
* .setParent(
* LocationName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setView(NotificationView.forNumber(0))
* .setLanguageCode("languageCode-2092349083")
* .build();
* while (true) {
* ListNotificationsResponse response =
* advisoryNotificationsServiceClient.listNotificationsCallable().call(request);
* for (Notification element : response.getNotificationsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listNotificationsCallable() {
return stub.listNotificationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a notification.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* NotificationName name =
* NotificationName.ofOrganizationLocationNotificationName(
* "[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]");
* Notification response = advisoryNotificationsServiceClient.getNotification(name);
* }
* }
*
* @param name Required. A name of the notification to retrieve. Format:
* organizations/{organization}/locations/{location}/notifications/{notification} or
* projects/{projects}/locations/{location}/notifications/{notification}.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Notification getNotification(NotificationName name) {
GetNotificationRequest request =
GetNotificationRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getNotification(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a notification.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* String name =
* NotificationName.ofOrganizationLocationNotificationName(
* "[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]")
* .toString();
* Notification response = advisoryNotificationsServiceClient.getNotification(name);
* }
* }
*
* @param name Required. A name of the notification to retrieve. Format:
* organizations/{organization}/locations/{location}/notifications/{notification} or
* projects/{projects}/locations/{location}/notifications/{notification}.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Notification getNotification(String name) {
GetNotificationRequest request = GetNotificationRequest.newBuilder().setName(name).build();
return getNotification(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a notification.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* GetNotificationRequest request =
* GetNotificationRequest.newBuilder()
* .setName(
* NotificationName.ofOrganizationLocationNotificationName(
* "[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]")
* .toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* Notification response = advisoryNotificationsServiceClient.getNotification(request);
* }
* }
*
* @param 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
*/
public final Notification getNotification(GetNotificationRequest request) {
return getNotificationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a notification.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* GetNotificationRequest request =
* GetNotificationRequest.newBuilder()
* .setName(
* NotificationName.ofOrganizationLocationNotificationName(
* "[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]")
* .toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* advisoryNotificationsServiceClient.getNotificationCallable().futureCall(request);
* // Do something.
* Notification response = future.get();
* }
* }
*/
public final UnaryCallable getNotificationCallable() {
return stub.getNotificationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get notification settings.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* SettingsName name = SettingsName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]");
* Settings response = advisoryNotificationsServiceClient.getSettings(name);
* }
* }
*
* @param name Required. The resource name of the settings to retrieve. Format:
* organizations/{organization}/locations/{location}/settings or
* projects/{projects}/locations/{location}/settings.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Settings getSettings(SettingsName name) {
GetSettingsRequest request =
GetSettingsRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getSettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get notification settings.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* String name =
* SettingsName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]").toString();
* Settings response = advisoryNotificationsServiceClient.getSettings(name);
* }
* }
*
* @param name Required. The resource name of the settings to retrieve. Format:
* organizations/{organization}/locations/{location}/settings or
* projects/{projects}/locations/{location}/settings.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Settings getSettings(String name) {
GetSettingsRequest request = GetSettingsRequest.newBuilder().setName(name).build();
return getSettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get notification settings.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* GetSettingsRequest request =
* GetSettingsRequest.newBuilder()
* .setName(
* SettingsName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]")
* .toString())
* .build();
* Settings response = advisoryNotificationsServiceClient.getSettings(request);
* }
* }
*
* @param 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
*/
public final Settings getSettings(GetSettingsRequest request) {
return getSettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get notification settings.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* GetSettingsRequest request =
* GetSettingsRequest.newBuilder()
* .setName(
* SettingsName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]")
* .toString())
* .build();
* ApiFuture future =
* advisoryNotificationsServiceClient.getSettingsCallable().futureCall(request);
* // Do something.
* Settings response = future.get();
* }
* }
*/
public final UnaryCallable getSettingsCallable() {
return stub.getSettingsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Update notification settings.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* Settings settings = Settings.newBuilder().build();
* Settings response = advisoryNotificationsServiceClient.updateSettings(settings);
* }
* }
*
* @param settings Required. New settings.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Settings updateSettings(Settings settings) {
UpdateSettingsRequest request =
UpdateSettingsRequest.newBuilder().setSettings(settings).build();
return updateSettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Update notification settings.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* UpdateSettingsRequest request =
* UpdateSettingsRequest.newBuilder().setSettings(Settings.newBuilder().build()).build();
* Settings response = advisoryNotificationsServiceClient.updateSettings(request);
* }
* }
*
* @param 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
*/
public final Settings updateSettings(UpdateSettingsRequest request) {
return updateSettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Update notification settings.
*
* Sample code:
*
*
{@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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
* AdvisoryNotificationsServiceClient.create()) {
* UpdateSettingsRequest request =
* UpdateSettingsRequest.newBuilder().setSettings(Settings.newBuilder().build()).build();
* ApiFuture future =
* advisoryNotificationsServiceClient.updateSettingsCallable().futureCall(request);
* // Do something.
* Settings response = future.get();
* }
* }
*/
public final UnaryCallable updateSettingsCallable() {
return stub.updateSettingsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListNotificationsPagedResponse
extends AbstractPagedListResponse<
ListNotificationsRequest,
ListNotificationsResponse,
Notification,
ListNotificationsPage,
ListNotificationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListNotificationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListNotificationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListNotificationsPagedResponse(ListNotificationsPage page) {
super(page, ListNotificationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListNotificationsPage
extends AbstractPage<
ListNotificationsRequest,
ListNotificationsResponse,
Notification,
ListNotificationsPage> {
private ListNotificationsPage(
PageContext context,
ListNotificationsResponse response) {
super(context, response);
}
private static ListNotificationsPage createEmptyPage() {
return new ListNotificationsPage(null, null);
}
@Override
protected ListNotificationsPage createPage(
PageContext context,
ListNotificationsResponse response) {
return new ListNotificationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListNotificationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListNotificationsRequest,
ListNotificationsResponse,
Notification,
ListNotificationsPage,
ListNotificationsFixedSizeCollection> {
private ListNotificationsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListNotificationsFixedSizeCollection createEmptyCollection() {
return new ListNotificationsFixedSizeCollection(null, 0);
}
@Override
protected ListNotificationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListNotificationsFixedSizeCollection(pages, collectionSize);
}
}
}