Class RegionNotificationEndpointsClient (1.20.0)

public class RegionNotificationEndpointsClient implements BackgroundResource

Service Description: The RegionNotificationEndpoints API.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String notificationEndpoint = "notificationEndpoint-354029664";
   NotificationEndpoint response =
       regionNotificationEndpointsClient.get(project, region, notificationEndpoint);
 }

Note: close() needs to be called on the RegionNotificationEndpointsClient 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 RegionNotificationEndpointsSettings 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
 RegionNotificationEndpointsSettings regionNotificationEndpointsSettings =
     RegionNotificationEndpointsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create(regionNotificationEndpointsSettings);

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
 RegionNotificationEndpointsSettings regionNotificationEndpointsSettings =
     RegionNotificationEndpointsSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create(regionNotificationEndpointsSettings);

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

Inheritance

java.lang.Object > RegionNotificationEndpointsClient

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

Constructs an instance of RegionNotificationEndpointsClient with default settings.

Returns

Type	Description
`RegionNotificationEndpointsClient`

Exceptions

Type	Description
`IOException`

create(RegionNotificationEndpointsSettings settings)

public static final RegionNotificationEndpointsClient create(RegionNotificationEndpointsSettings settings)

Constructs an instance of RegionNotificationEndpointsClient, 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`	`RegionNotificationEndpointsSettings`

Returns

Type	Description
`RegionNotificationEndpointsClient`

Exceptions

Type	Description
`IOException`

create(RegionNotificationEndpointsStub stub)

public static final RegionNotificationEndpointsClient create(RegionNotificationEndpointsStub stub)

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

Parameter

Name	Description
`stub`	`RegionNotificationEndpointsStub`

Returns

Type	Description
`RegionNotificationEndpointsClient`

Constructors

RegionNotificationEndpointsClient(RegionNotificationEndpointsSettings settings)

protected RegionNotificationEndpointsClient(RegionNotificationEndpointsSettings settings)

Constructs an instance of RegionNotificationEndpointsClient, 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`	`RegionNotificationEndpointsSettings`

RegionNotificationEndpointsClient(RegionNotificationEndpointsStub stub)

protected RegionNotificationEndpointsClient(RegionNotificationEndpointsStub stub)

Parameter

Name	Description
`stub`	`RegionNotificationEndpointsStub`

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

deleteAsync(DeleteRegionNotificationEndpointRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionNotificationEndpointRequest request)

Deletes the specified NotificationEndpoint in the given region

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   DeleteRegionNotificationEndpointRequest request =
       DeleteRegionNotificationEndpointRequest.newBuilder()
           .setNotificationEndpoint("notificationEndpoint-354029664")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionNotificationEndpointsClient.deleteAsync(request).get();
 }

Parameter

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

Returns

Type	Description
`OperationFuture<Operation,Operation>`

deleteAsync(String project, String region, String notificationEndpoint)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String notificationEndpoint)

Deletes the specified NotificationEndpoint in the given region

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String notificationEndpoint = "notificationEndpoint-354029664";
   Operation response =
       regionNotificationEndpointsClient
           .deleteAsync(project, region, notificationEndpoint)
           .get();
 }

Parameters

Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region scoping this request.
`notificationEndpoint`	`String` Name of the NotificationEndpoint resource to delete.

Returns

Type	Description
`OperationFuture<Operation,Operation>`

deleteCallable()

public final UnaryCallable<DeleteRegionNotificationEndpointRequest,Operation> deleteCallable()

Deletes the specified NotificationEndpoint in the given region

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   DeleteRegionNotificationEndpointRequest request =
       DeleteRegionNotificationEndpointRequest.newBuilder()
           .setNotificationEndpoint("notificationEndpoint-354029664")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionNotificationEndpointsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
`UnaryCallable<DeleteRegionNotificationEndpointRequest,Operation>`

deleteOperationCallable()

public final OperationCallable<DeleteRegionNotificationEndpointRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified NotificationEndpoint in the given region

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   DeleteRegionNotificationEndpointRequest request =
       DeleteRegionNotificationEndpointRequest.newBuilder()
           .setNotificationEndpoint("notificationEndpoint-354029664")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionNotificationEndpointsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
`OperationCallable<DeleteRegionNotificationEndpointRequest,Operation,Operation>`

get(GetRegionNotificationEndpointRequest request)

public final NotificationEndpoint get(GetRegionNotificationEndpointRequest request)

Returns the specified NotificationEndpoint resource in the given region.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   GetRegionNotificationEndpointRequest request =
       GetRegionNotificationEndpointRequest.newBuilder()
           .setNotificationEndpoint("notificationEndpoint-354029664")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   NotificationEndpoint response = regionNotificationEndpointsClient.get(request);
 }

Parameter

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

Returns

Type	Description
`NotificationEndpoint`

get(String project, String region, String notificationEndpoint)

public final NotificationEndpoint get(String project, String region, String notificationEndpoint)

Returns the specified NotificationEndpoint resource in the given region.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String notificationEndpoint = "notificationEndpoint-354029664";
   NotificationEndpoint response =
       regionNotificationEndpointsClient.get(project, region, notificationEndpoint);
 }

Parameters

Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region scoping this request.
`notificationEndpoint`	`String` Name of the NotificationEndpoint resource to return.

Returns

Type	Description
`NotificationEndpoint`

getCallable()

public final UnaryCallable<GetRegionNotificationEndpointRequest,NotificationEndpoint> getCallable()

Returns the specified NotificationEndpoint resource in the given region.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   GetRegionNotificationEndpointRequest request =
       GetRegionNotificationEndpointRequest.newBuilder()
           .setNotificationEndpoint("notificationEndpoint-354029664")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<NotificationEndpoint> future =
       regionNotificationEndpointsClient.getCallable().futureCall(request);
   // Do something.
   NotificationEndpoint response = future.get();
 }

Returns

Type	Description
`UnaryCallable<GetRegionNotificationEndpointRequest,NotificationEndpoint>`

getSettings()

public final RegionNotificationEndpointsSettings getSettings()

Returns

Type	Description
`RegionNotificationEndpointsSettings`

getStub()

public RegionNotificationEndpointsStub getStub()

Returns

Type	Description
`RegionNotificationEndpointsStub`

insertAsync(InsertRegionNotificationEndpointRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRegionNotificationEndpointRequest request)

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   InsertRegionNotificationEndpointRequest request =
       InsertRegionNotificationEndpointRequest.newBuilder()
           .setNotificationEndpointResource(NotificationEndpoint.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionNotificationEndpointsClient.insertAsync(request).get();
 }

Parameter

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

Returns

Type	Description
`OperationFuture<Operation,Operation>`

insertAsync(String project, String region, NotificationEndpoint notificationEndpointResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, NotificationEndpoint notificationEndpointResource)

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   NotificationEndpoint notificationEndpointResource = NotificationEndpoint.newBuilder().build();
   Operation response =
       regionNotificationEndpointsClient
           .insertAsync(project, region, notificationEndpointResource)
           .get();
 }

Parameters

Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region scoping this request.
`notificationEndpointResource`	`NotificationEndpoint` The body resource for this request

Returns

Type	Description
`OperationFuture<Operation,Operation>`

insertCallable()

public final UnaryCallable<InsertRegionNotificationEndpointRequest,Operation> insertCallable()

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   InsertRegionNotificationEndpointRequest request =
       InsertRegionNotificationEndpointRequest.newBuilder()
           .setNotificationEndpointResource(NotificationEndpoint.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionNotificationEndpointsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
`UnaryCallable<InsertRegionNotificationEndpointRequest,Operation>`

insertOperationCallable()

public final OperationCallable<InsertRegionNotificationEndpointRequest,Operation,Operation> insertOperationCallable()

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   InsertRegionNotificationEndpointRequest request =
       InsertRegionNotificationEndpointRequest.newBuilder()
           .setNotificationEndpointResource(NotificationEndpoint.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionNotificationEndpointsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
`OperationCallable<InsertRegionNotificationEndpointRequest,Operation,Operation>`

isShutdown()

public boolean isShutdown()

Returns

Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns

Type	Description
`boolean`

list(ListRegionNotificationEndpointsRequest request)

public final RegionNotificationEndpointsClient.ListPagedResponse list(ListRegionNotificationEndpointsRequest request)

Lists the NotificationEndpoints for a project in the given region.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   ListRegionNotificationEndpointsRequest request =
       ListRegionNotificationEndpointsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (NotificationEndpoint element :
       regionNotificationEndpointsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
`RegionNotificationEndpointsClient.ListPagedResponse`

list(String project, String region)

public final RegionNotificationEndpointsClient.ListPagedResponse list(String project, String region)

Lists the NotificationEndpoints for a project in the given region.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (NotificationEndpoint element :
       regionNotificationEndpointsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters

Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region scoping this request.

Returns

Type	Description
`RegionNotificationEndpointsClient.ListPagedResponse`

listCallable()

public final UnaryCallable<ListRegionNotificationEndpointsRequest,NotificationEndpointList> listCallable()

Lists the NotificationEndpoints for a project in the given region.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   ListRegionNotificationEndpointsRequest request =
       ListRegionNotificationEndpointsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     NotificationEndpointList response =
         regionNotificationEndpointsClient.listCallable().call(request);
     for (NotificationEndpoint element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
`UnaryCallable<ListRegionNotificationEndpointsRequest,NotificationEndpointList>`

listPagedCallable()

public final UnaryCallable<ListRegionNotificationEndpointsRequest,RegionNotificationEndpointsClient.ListPagedResponse> listPagedCallable()

Lists the NotificationEndpoints for a project in the given region.

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 (RegionNotificationEndpointsClient regionNotificationEndpointsClient =
     RegionNotificationEndpointsClient.create()) {
   ListRegionNotificationEndpointsRequest request =
       ListRegionNotificationEndpointsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<NotificationEndpoint> future =
       regionNotificationEndpointsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (NotificationEndpoint element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
`UnaryCallable<ListRegionNotificationEndpointsRequest,ListPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()