com.google.cloud.monitoring.v3

Class NotificationChannelServiceClient

java.lang.Object

com.google.cloud.monitoring.v3.NotificationChannelServiceClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
public class NotificationChannelServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.

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:

 
 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelDescriptorName name = NotificationChannelDescriptorName.of("[PROJECT]", "[CHANNEL_DESCRIPTOR]");
   NotificationChannelDescriptor response = notificationChannelServiceClient.getNotificationChannelDescriptor(name);
 }
 
 

Note: close() needs to be called on the notificationChannelServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of NotificationChannelServiceSettings to create(). For example:

To customize credentials:

 
 NotificationChannelServiceSettings notificationChannelServiceSettings =
     NotificationChannelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NotificationChannelServiceClient notificationChannelServiceClient =
     NotificationChannelServiceClient.create(notificationChannelServiceSettings);
 
 

To customize the endpoint:

 
 NotificationChannelServiceSettings notificationChannelServiceSettings =
     NotificationChannelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 NotificationChannelServiceClient notificationChannelServiceClient =
     NotificationChannelServiceClient.create(notificationChannelServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationChannelServiceClient.ListNotificationChannelDescriptorsFixedSizeCollection
static class	NotificationChannelServiceClient.ListNotificationChannelDescriptorsPage
static class	NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse
static class	NotificationChannelServiceClient.ListNotificationChannelsFixedSizeCollection
static class	NotificationChannelServiceClient.ListNotificationChannelsPage
static class	NotificationChannelServiceClient.ListNotificationChannelsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NotificationChannelServiceClient(NotificationChannelServiceSettings settings) Constructs an instance of NotificationChannelServiceClient, using the given settings.
protected	NotificationChannelServiceClient(NotificationChannelServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static NotificationChannelServiceClient	create() Constructs an instance of NotificationChannelServiceClient with default settings.
static NotificationChannelServiceClient	create(NotificationChannelServiceSettings settings) Constructs an instance of NotificationChannelServiceClient, using the given settings.
static NotificationChannelServiceClient	create(NotificationChannelServiceStub stub) Constructs an instance of NotificationChannelServiceClient, using the given stub for making calls.
NotificationChannel	createNotificationChannel(CreateNotificationChannelRequest request) Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.
NotificationChannel	createNotificationChannel(ProjectName name, NotificationChannel notificationChannel) Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.
NotificationChannel	createNotificationChannel(String name, NotificationChannel notificationChannel) Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.
com.google.api.gax.rpc.UnaryCallable<CreateNotificationChannelRequest,NotificationChannel>	createNotificationChannelCallable() Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.
void	deleteNotificationChannel(DeleteNotificationChannelRequest request) Deletes a notification channel.
void	deleteNotificationChannel(NotificationChannelName name, boolean force) Deletes a notification channel.
void	deleteNotificationChannel(String name, boolean force) Deletes a notification channel.
com.google.api.gax.rpc.UnaryCallable<DeleteNotificationChannelRequest,Empty>	deleteNotificationChannelCallable() Deletes a notification channel.
NotificationChannel	getNotificationChannel(GetNotificationChannelRequest request) Gets a single notification channel.
NotificationChannel	getNotificationChannel(NotificationChannelName name) Gets a single notification channel.
NotificationChannel	getNotificationChannel(String name) Gets a single notification channel.
com.google.api.gax.rpc.UnaryCallable<GetNotificationChannelRequest,NotificationChannel>	getNotificationChannelCallable() Gets a single notification channel.
NotificationChannelDescriptor	getNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request) Gets a single channel descriptor.
NotificationChannelDescriptor	getNotificationChannelDescriptor(NotificationChannelDescriptorName name) Gets a single channel descriptor.
NotificationChannelDescriptor	getNotificationChannelDescriptor(String name) Gets a single channel descriptor.
com.google.api.gax.rpc.UnaryCallable<GetNotificationChannelDescriptorRequest,NotificationChannelDescriptor>	getNotificationChannelDescriptorCallable() Gets a single channel descriptor.
NotificationChannelServiceSettings	getSettings()
NotificationChannelServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse	listNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request) Lists the descriptors for supported channel types.
NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse	listNotificationChannelDescriptors(ProjectName name) Lists the descriptors for supported channel types.
NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse	listNotificationChannelDescriptors(String name) Lists the descriptors for supported channel types.
com.google.api.gax.rpc.UnaryCallable<ListNotificationChannelDescriptorsRequest,ListNotificationChannelDescriptorsResponse>	listNotificationChannelDescriptorsCallable() Lists the descriptors for supported channel types.
com.google.api.gax.rpc.UnaryCallable<ListNotificationChannelDescriptorsRequest,NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse>	listNotificationChannelDescriptorsPagedCallable() Lists the descriptors for supported channel types.
NotificationChannelServiceClient.ListNotificationChannelsPagedResponse	listNotificationChannels(ListNotificationChannelsRequest request) Lists the notification channels that have been created for the project.
NotificationChannelServiceClient.ListNotificationChannelsPagedResponse	listNotificationChannels(ProjectName name) Lists the notification channels that have been created for the project.
NotificationChannelServiceClient.ListNotificationChannelsPagedResponse	listNotificationChannels(String name) Lists the notification channels that have been created for the project.
com.google.api.gax.rpc.UnaryCallable<ListNotificationChannelsRequest,ListNotificationChannelsResponse>	listNotificationChannelsCallable() Lists the notification channels that have been created for the project.
com.google.api.gax.rpc.UnaryCallable<ListNotificationChannelsRequest,NotificationChannelServiceClient.ListNotificationChannelsPagedResponse>	listNotificationChannelsPagedCallable() Lists the notification channels that have been created for the project.
void	shutdown()
void	shutdownNow()
NotificationChannel	updateNotificationChannel(FieldMask updateMask, NotificationChannel notificationChannel) Updates a notification channel.
NotificationChannel	updateNotificationChannel(UpdateNotificationChannelRequest request) Updates a notification channel.
com.google.api.gax.rpc.UnaryCallable<UpdateNotificationChannelRequest,NotificationChannel>	updateNotificationChannelCallable() Updates a notification channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationChannelServiceClient

protected NotificationChannelServiceClient(NotificationChannelServiceSettings settings)
                                    throws IOException

Constructs an instance of NotificationChannelServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

NotificationChannelServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected NotificationChannelServiceClient(NotificationChannelServiceStub stub)

Method Detail

create

public static final NotificationChannelServiceClient create()
                                                     throws IOException

Constructs an instance of NotificationChannelServiceClient with default settings.

Throws:

IOException

create

public static final NotificationChannelServiceClient create(NotificationChannelServiceSettings settings)
                                                     throws IOException

Constructs an instance of NotificationChannelServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final NotificationChannelServiceClient create(NotificationChannelServiceStub stub)

Constructs an instance of NotificationChannelServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use NotificationChannelServiceSettings}.

getSettings

public final NotificationChannelServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public NotificationChannelServiceStub getStub()

listNotificationChannelDescriptors

public final NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse listNotificationChannelDescriptors(ProjectName name)

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (NotificationChannelDescriptor element : notificationChannelServiceClient.listNotificationChannelDescriptors(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

projects/[PROJECT_ID]

Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the [GetNotificationChannelDescriptor][google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptor] operation, instead.

Throws:

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

listNotificationChannelDescriptors

public final NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse listNotificationChannelDescriptors(String name)

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (NotificationChannelDescriptor element : notificationChannelServiceClient.listNotificationChannelDescriptors(name.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

projects/[PROJECT_ID]

Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the [GetNotificationChannelDescriptor][google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptor] operation, instead.

Throws:

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

listNotificationChannelDescriptors

public final NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse listNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request)

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListNotificationChannelDescriptorsRequest request = ListNotificationChannelDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   for (NotificationChannelDescriptor element : notificationChannelServiceClient.listNotificationChannelDescriptors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

listNotificationChannelDescriptorsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNotificationChannelDescriptorsRequest,NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse> listNotificationChannelDescriptorsPagedCallable()

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListNotificationChannelDescriptorsRequest request = ListNotificationChannelDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListNotificationChannelDescriptorsPagedResponse> future = notificationChannelServiceClient.listNotificationChannelDescriptorsPagedCallable().futureCall(request);
   // Do something
   for (NotificationChannelDescriptor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listNotificationChannelDescriptorsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNotificationChannelDescriptorsRequest,ListNotificationChannelDescriptorsResponse> listNotificationChannelDescriptorsCallable()

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListNotificationChannelDescriptorsRequest request = ListNotificationChannelDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   while (true) {
     ListNotificationChannelDescriptorsResponse response = notificationChannelServiceClient.listNotificationChannelDescriptorsCallable().call(request);
     for (NotificationChannelDescriptor element : response.getChannelDescriptorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getNotificationChannelDescriptor

public final NotificationChannelDescriptor getNotificationChannelDescriptor(NotificationChannelDescriptorName name)

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelDescriptorName name = NotificationChannelDescriptorName.of("[PROJECT]", "[CHANNEL_DESCRIPTOR]");
   NotificationChannelDescriptor response = notificationChannelServiceClient.getNotificationChannelDescriptor(name);
 }
 

Parameters:

name - The channel type for which to execute the request. The format is `projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}`.

Throws:

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

getNotificationChannelDescriptor

public final NotificationChannelDescriptor getNotificationChannelDescriptor(String name)

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelDescriptorName name = NotificationChannelDescriptorName.of("[PROJECT]", "[CHANNEL_DESCRIPTOR]");
   NotificationChannelDescriptor response = notificationChannelServiceClient.getNotificationChannelDescriptor(name.toString());
 }
 

Parameters:

name - The channel type for which to execute the request. The format is `projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}`.

Throws:

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

getNotificationChannelDescriptor

public final NotificationChannelDescriptor getNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request)

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelDescriptorName name = NotificationChannelDescriptorName.of("[PROJECT]", "[CHANNEL_DESCRIPTOR]");
   GetNotificationChannelDescriptorRequest request = GetNotificationChannelDescriptorRequest.newBuilder()
     .setName(name.toString())
     .build();
   NotificationChannelDescriptor response = notificationChannelServiceClient.getNotificationChannelDescriptor(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

getNotificationChannelDescriptorCallable

public final com.google.api.gax.rpc.UnaryCallable<GetNotificationChannelDescriptorRequest,NotificationChannelDescriptor> getNotificationChannelDescriptorCallable()

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelDescriptorName name = NotificationChannelDescriptorName.of("[PROJECT]", "[CHANNEL_DESCRIPTOR]");
   GetNotificationChannelDescriptorRequest request = GetNotificationChannelDescriptorRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<NotificationChannelDescriptor> future = notificationChannelServiceClient.getNotificationChannelDescriptorCallable().futureCall(request);
   // Do something
   NotificationChannelDescriptor response = future.get();
 }
 

listNotificationChannels

public final NotificationChannelServiceClient.ListNotificationChannelsPagedResponse listNotificationChannels(ProjectName name)

Lists the notification channels that have been created for the project.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (NotificationChannel element : notificationChannelServiceClient.listNotificationChannels(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The project on which to execute the request. The format is `projects/[PROJECT_ID]`. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] operation.

Throws:

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

listNotificationChannels

public final NotificationChannelServiceClient.ListNotificationChannelsPagedResponse listNotificationChannels(String name)

Lists the notification channels that have been created for the project.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (NotificationChannel element : notificationChannelServiceClient.listNotificationChannels(name.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The project on which to execute the request. The format is `projects/[PROJECT_ID]`. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] operation.

Throws:

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

listNotificationChannels

public final NotificationChannelServiceClient.ListNotificationChannelsPagedResponse listNotificationChannels(ListNotificationChannelsRequest request)

Lists the notification channels that have been created for the project.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListNotificationChannelsRequest request = ListNotificationChannelsRequest.newBuilder()
     .setName(name.toString())
     .build();
   for (NotificationChannel element : notificationChannelServiceClient.listNotificationChannels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

listNotificationChannelsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNotificationChannelsRequest,NotificationChannelServiceClient.ListNotificationChannelsPagedResponse> listNotificationChannelsPagedCallable()

Lists the notification channels that have been created for the project.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListNotificationChannelsRequest request = ListNotificationChannelsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListNotificationChannelsPagedResponse> future = notificationChannelServiceClient.listNotificationChannelsPagedCallable().futureCall(request);
   // Do something
   for (NotificationChannel element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listNotificationChannelsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNotificationChannelsRequest,ListNotificationChannelsResponse> listNotificationChannelsCallable()

Lists the notification channels that have been created for the project.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListNotificationChannelsRequest request = ListNotificationChannelsRequest.newBuilder()
     .setName(name.toString())
     .build();
   while (true) {
     ListNotificationChannelsResponse response = notificationChannelServiceClient.listNotificationChannelsCallable().call(request);
     for (NotificationChannel element : response.getNotificationChannelsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getNotificationChannel

public final NotificationChannel getNotificationChannel(NotificationChannelName name)

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelName name = NotificationChannelName.of("[PROJECT]", "[NOTIFICATION_CHANNEL]");
   NotificationChannel response = notificationChannelServiceClient.getNotificationChannel(name);
 }
 

Parameters:

name - The channel for which to execute the request. The format is `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]`.

Throws:

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

getNotificationChannel

public final NotificationChannel getNotificationChannel(String name)

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelName name = NotificationChannelName.of("[PROJECT]", "[NOTIFICATION_CHANNEL]");
   NotificationChannel response = notificationChannelServiceClient.getNotificationChannel(name.toString());
 }
 

Parameters:

name - The channel for which to execute the request. The format is `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]`.

Throws:

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

getNotificationChannel

public final NotificationChannel getNotificationChannel(GetNotificationChannelRequest request)

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelName name = NotificationChannelName.of("[PROJECT]", "[NOTIFICATION_CHANNEL]");
   GetNotificationChannelRequest request = GetNotificationChannelRequest.newBuilder()
     .setName(name.toString())
     .build();
   NotificationChannel response = notificationChannelServiceClient.getNotificationChannel(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

getNotificationChannelCallable

public final com.google.api.gax.rpc.UnaryCallable<GetNotificationChannelRequest,NotificationChannel> getNotificationChannelCallable()

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelName name = NotificationChannelName.of("[PROJECT]", "[NOTIFICATION_CHANNEL]");
   GetNotificationChannelRequest request = GetNotificationChannelRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<NotificationChannel> future = notificationChannelServiceClient.getNotificationChannelCallable().futureCall(request);
   // Do something
   NotificationChannel response = future.get();
 }
 

createNotificationChannel

public final NotificationChannel createNotificationChannel(ProjectName name,
                                                           NotificationChannel notificationChannel)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   NotificationChannel notificationChannel = NotificationChannel.newBuilder().build();
   NotificationChannel response = notificationChannelServiceClient.createNotificationChannel(name, notificationChannel);
 }
 

Parameters:

name - The project on which to execute the request. The format is:

projects/[PROJECT_ID]

Note that this names the container into which the channel will be written. This does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add `/notificationChannels/[CHANNEL_ID]` to identify the channel.

notificationChannel - The definition of the `NotificationChannel` to create.

Throws:

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

createNotificationChannel

public final NotificationChannel createNotificationChannel(String name,
                                                           NotificationChannel notificationChannel)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   NotificationChannel notificationChannel = NotificationChannel.newBuilder().build();
   NotificationChannel response = notificationChannelServiceClient.createNotificationChannel(name.toString(), notificationChannel);
 }
 

Parameters:

name - The project on which to execute the request. The format is:

projects/[PROJECT_ID]

Note that this names the container into which the channel will be written. This does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add `/notificationChannels/[CHANNEL_ID]` to identify the channel.

notificationChannel - The definition of the `NotificationChannel` to create.

Throws:

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

createNotificationChannel

public final NotificationChannel createNotificationChannel(CreateNotificationChannelRequest request)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   NotificationChannel notificationChannel = NotificationChannel.newBuilder().build();
   CreateNotificationChannelRequest request = CreateNotificationChannelRequest.newBuilder()
     .setName(name.toString())
     .setNotificationChannel(notificationChannel)
     .build();
   NotificationChannel response = notificationChannelServiceClient.createNotificationChannel(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

createNotificationChannelCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateNotificationChannelRequest,NotificationChannel> createNotificationChannelCallable()

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   NotificationChannel notificationChannel = NotificationChannel.newBuilder().build();
   CreateNotificationChannelRequest request = CreateNotificationChannelRequest.newBuilder()
     .setName(name.toString())
     .setNotificationChannel(notificationChannel)
     .build();
   ApiFuture<NotificationChannel> future = notificationChannelServiceClient.createNotificationChannelCallable().futureCall(request);
   // Do something
   NotificationChannel response = future.get();
 }
 

updateNotificationChannel

public final NotificationChannel updateNotificationChannel(FieldMask updateMask,
                                                           NotificationChannel notificationChannel)

Updates a notification channel. Fields not specified in the field mask remain unchanged.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   FieldMask updateMask = FieldMask.newBuilder().build();
   NotificationChannel notificationChannel = NotificationChannel.newBuilder().build();
   NotificationChannel response = notificationChannelServiceClient.updateNotificationChannel(updateMask, notificationChannel);
 }
 

Parameters:

updateMask - The fields to update.

notificationChannel - A description of the changes to be applied to the specified notification channel. The description must provide a definition for fields to be updated; the names of these fields should also be included in the `update_mask`.

Throws:

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

updateNotificationChannel

public final NotificationChannel updateNotificationChannel(UpdateNotificationChannelRequest request)

Updates a notification channel. Fields not specified in the field mask remain unchanged.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannel notificationChannel = NotificationChannel.newBuilder().build();
   UpdateNotificationChannelRequest request = UpdateNotificationChannelRequest.newBuilder()
     .setNotificationChannel(notificationChannel)
     .build();
   NotificationChannel response = notificationChannelServiceClient.updateNotificationChannel(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

updateNotificationChannelCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateNotificationChannelRequest,NotificationChannel> updateNotificationChannelCallable()

Updates a notification channel. Fields not specified in the field mask remain unchanged.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannel notificationChannel = NotificationChannel.newBuilder().build();
   UpdateNotificationChannelRequest request = UpdateNotificationChannelRequest.newBuilder()
     .setNotificationChannel(notificationChannel)
     .build();
   ApiFuture<NotificationChannel> future = notificationChannelServiceClient.updateNotificationChannelCallable().futureCall(request);
   // Do something
   NotificationChannel response = future.get();
 }
 

deleteNotificationChannel

public final void deleteNotificationChannel(NotificationChannelName name,
                                            boolean force)

Deletes a notification channel.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelName name = NotificationChannelName.of("[PROJECT]", "[NOTIFICATION_CHANNEL]");
   boolean force = false;
   notificationChannelServiceClient.deleteNotificationChannel(name, force);
 }
 

Parameters:

name - The channel for which to execute the request. The format is `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]`.

force - If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

Throws:

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

deleteNotificationChannel

public final void deleteNotificationChannel(String name,
                                            boolean force)

Deletes a notification channel.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelName name = NotificationChannelName.of("[PROJECT]", "[NOTIFICATION_CHANNEL]");
   boolean force = false;
   notificationChannelServiceClient.deleteNotificationChannel(name.toString(), force);
 }
 

Parameters:

name - The channel for which to execute the request. The format is `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]`.

force - If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

Throws:

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

deleteNotificationChannel

public final void deleteNotificationChannel(DeleteNotificationChannelRequest request)

Deletes a notification channel.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelName name = NotificationChannelName.of("[PROJECT]", "[NOTIFICATION_CHANNEL]");
   DeleteNotificationChannelRequest request = DeleteNotificationChannelRequest.newBuilder()
     .setName(name.toString())
     .build();
   notificationChannelServiceClient.deleteNotificationChannel(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

deleteNotificationChannelCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteNotificationChannelRequest,Empty> deleteNotificationChannelCallable()

Deletes a notification channel.

Sample code:

 try (NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.create()) {
   NotificationChannelName name = NotificationChannelName.of("[PROJECT]", "[NOTIFICATION_CHANNEL]");
   DeleteNotificationChannelRequest request = DeleteNotificationChannelRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = notificationChannelServiceClient.deleteNotificationChannelCallable().futureCall(request);
   // Do something
   future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

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

isShutdown

public boolean isShutdown()

Specified by:

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

isTerminated

public boolean isTerminated()

Specified by:

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

shutdownNow

public void shutdownNow()

Specified by:

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

awaitTermination

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

Specified by:

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

Throws:

InterruptedException