Class AdvisoryNotificationsServiceClient (0.4.0)

public class AdvisoryNotificationsServiceClient implements BackgroundResource

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:


 // 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.of("[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().

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 AdvisoryNotificationsServiceSettings 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
 AdvisoryNotificationsServiceSettings advisoryNotificationsServiceSettings =
     AdvisoryNotificationsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create(advisoryNotificationsServiceSettings);

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
 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:


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

Inheritance

java.lang.Object > AdvisoryNotificationsServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final AdvisoryNotificationsServiceClient create()

Constructs an instance of AdvisoryNotificationsServiceClient with default settings.

Returns
Type	Description
`AdvisoryNotificationsServiceClient`

Exceptions
Type	Description
`IOException`

create(AdvisoryNotificationsServiceSettings settings)

public static final AdvisoryNotificationsServiceClient create(AdvisoryNotificationsServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`AdvisoryNotificationsServiceSettings`

Returns
Type	Description
`AdvisoryNotificationsServiceClient`

Exceptions
Type	Description
`IOException`

create(AdvisoryNotificationsServiceStub stub)

public static final AdvisoryNotificationsServiceClient create(AdvisoryNotificationsServiceStub stub)

Constructs an instance of AdvisoryNotificationsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AdvisoryNotificationsServiceSettings).

Parameter
Name	Description
`stub`	`AdvisoryNotificationsServiceStub`

Returns
Type	Description
`AdvisoryNotificationsServiceClient`

Constructors

AdvisoryNotificationsServiceClient(AdvisoryNotificationsServiceSettings settings)

protected AdvisoryNotificationsServiceClient(AdvisoryNotificationsServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`AdvisoryNotificationsServiceSettings`

AdvisoryNotificationsServiceClient(AdvisoryNotificationsServiceStub stub)

protected AdvisoryNotificationsServiceClient(AdvisoryNotificationsServiceStub stub)

Parameter
Name	Description
`stub`	`AdvisoryNotificationsServiceStub`

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

getNotification(GetNotificationRequest request)

public final Notification getNotification(GetNotificationRequest request)

Gets a notification.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   GetNotificationRequest request =
       GetNotificationRequest.newBuilder()
           .setName(
               NotificationName.of("[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]").toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   Notification response = advisoryNotificationsServiceClient.getNotification(request);
 }

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

Returns
Type	Description
`Notification`

getNotification(NotificationName name)

public final Notification getNotification(NotificationName name)

Gets a notification.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   NotificationName name = NotificationName.of("[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]");
   Notification response = advisoryNotificationsServiceClient.getNotification(name);
 }

Parameter
Name	Description
`name`	`NotificationName` Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification}.

Returns
Type	Description
`Notification`

getNotification(String name)

public final Notification getNotification(String name)

Gets a notification.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   String name =
       NotificationName.of("[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]").toString();
   Notification response = advisoryNotificationsServiceClient.getNotification(name);
 }

Parameter
Name	Description
`name`	`String` Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification}.

Returns
Type	Description
`Notification`

getNotificationCallable()

public final UnaryCallable<GetNotificationRequest,Notification> getNotificationCallable()

Gets a notification.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   GetNotificationRequest request =
       GetNotificationRequest.newBuilder()
           .setName(
               NotificationName.of("[ORGANIZATION]", "[LOCATION]", "[NOTIFICATION]").toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<Notification> future =
       advisoryNotificationsServiceClient.getNotificationCallable().futureCall(request);
   // Do something.
   Notification response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetNotificationRequest,Notification>`

getSettings()

public final AdvisoryNotificationsServiceSettings getSettings()

Returns
Type	Description
`AdvisoryNotificationsServiceSettings`

getStub()

public AdvisoryNotificationsServiceStub getStub()

Returns
Type	Description
`AdvisoryNotificationsServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listNotifications(ListNotificationsRequest request)

public final AdvisoryNotificationsServiceClient.ListNotificationsPagedResponse listNotifications(ListNotificationsRequest request)

Lists notifications under a given parent.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   ListNotificationsRequest request =
       ListNotificationsRequest.newBuilder()
           .setParent(LocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(NotificationView.forNumber(0))
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (Notification element :
       advisoryNotificationsServiceClient.listNotifications(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`AdvisoryNotificationsServiceClient.ListNotificationsPagedResponse`

listNotifications(LocationName parent)

public final AdvisoryNotificationsServiceClient.ListNotificationsPagedResponse listNotifications(LocationName parent)

Lists notifications under a given parent.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   LocationName parent = LocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (Notification element :
       advisoryNotificationsServiceClient.listNotifications(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`LocationName` Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}".

Returns
Type	Description
`AdvisoryNotificationsServiceClient.ListNotificationsPagedResponse`

listNotifications(String parent)

public final AdvisoryNotificationsServiceClient.ListNotificationsPagedResponse listNotifications(String parent)

Lists notifications under a given parent.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   String parent = LocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (Notification element :
       advisoryNotificationsServiceClient.listNotifications(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}".

Returns
Type	Description
`AdvisoryNotificationsServiceClient.ListNotificationsPagedResponse`

listNotificationsCallable()

public final UnaryCallable<ListNotificationsRequest,ListNotificationsResponse> listNotificationsCallable()

Lists notifications under a given parent.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   ListNotificationsRequest request =
       ListNotificationsRequest.newBuilder()
           .setParent(LocationName.of("[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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListNotificationsRequest,ListNotificationsResponse>`

listNotificationsPagedCallable()

public final UnaryCallable<ListNotificationsRequest,AdvisoryNotificationsServiceClient.ListNotificationsPagedResponse> listNotificationsPagedCallable()

Lists notifications under a given parent.

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 (AdvisoryNotificationsServiceClient advisoryNotificationsServiceClient =
     AdvisoryNotificationsServiceClient.create()) {
   ListNotificationsRequest request =
       ListNotificationsRequest.newBuilder()
           .setParent(LocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(NotificationView.forNumber(0))
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<Notification> future =
       advisoryNotificationsServiceClient.listNotificationsPagedCallable().futureCall(request);
   // Do something.
   for (Notification element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListNotificationsRequest,ListNotificationsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()