Interface NotificationChannelServiceGrpc.AsyncService (3.55.0)

Version latest

• 3.55.0 (latest)
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.6
• 3.3.6
• 3.2.10

public static interface NotificationChannelServiceGrpc.AsyncService

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

Methods

createNotificationChannel(CreateNotificationChannelRequest request, StreamObserver<NotificationChannel> responseObserver)

public default void createNotificationChannel(CreateNotificationChannelRequest request, StreamObserver<NotificationChannel> responseObserver)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service. Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

Parameters
Name	Description
request	CreateNotificationChannelRequest
responseObserver	io.grpc.stub.StreamObserver<NotificationChannel>

deleteNotificationChannel(DeleteNotificationChannelRequest request, StreamObserver<Empty> responseObserver)

public default void deleteNotificationChannel(DeleteNotificationChannelRequest request, StreamObserver<Empty> responseObserver)

Deletes a notification channel. Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

Parameters
Name	Description
request	DeleteNotificationChannelRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

getNotificationChannel(GetNotificationChannelRequest request, StreamObserver<NotificationChannel> responseObserver)

public default void getNotificationChannel(GetNotificationChannelRequest request, StreamObserver<NotificationChannel> responseObserver)

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.

Parameters
Name	Description
request	GetNotificationChannelRequest
responseObserver	io.grpc.stub.StreamObserver<NotificationChannel>

getNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request, StreamObserver<NotificationChannelDescriptor> responseObserver)

public default void getNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request, StreamObserver<NotificationChannelDescriptor> responseObserver)

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

Parameters
Name	Description
request	GetNotificationChannelDescriptorRequest
responseObserver	io.grpc.stub.StreamObserver<NotificationChannelDescriptor>

getNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request, StreamObserver<GetNotificationChannelVerificationCodeResponse> responseObserver)

public default void getNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request, StreamObserver<GetNotificationChannelVerificationCodeResponse> responseObserver)

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state). There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.

Parameters
Name	Description
request	GetNotificationChannelVerificationCodeRequest
responseObserver	io.grpc.stub.StreamObserver<GetNotificationChannelVerificationCodeResponse>

listNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request, StreamObserver<ListNotificationChannelDescriptorsResponse> responseObserver)

public default void listNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request, StreamObserver<ListNotificationChannelDescriptorsResponse> responseObserver)

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

Parameters
Name	Description
request	ListNotificationChannelDescriptorsRequest
responseObserver	io.grpc.stub.StreamObserver<ListNotificationChannelDescriptorsResponse>

listNotificationChannels(ListNotificationChannelsRequest request, StreamObserver<ListNotificationChannelsResponse> responseObserver)

public default void listNotificationChannels(ListNotificationChannelsRequest request, StreamObserver<ListNotificationChannelsResponse> responseObserver)

Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the ListNotificationChannelDescriptors method.

Parameters
Name	Description
request	ListNotificationChannelsRequest
responseObserver	io.grpc.stub.StreamObserver<ListNotificationChannelsResponse>

sendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request, StreamObserver<Empty> responseObserver)

public default void sendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request, StreamObserver<Empty> responseObserver)

Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel.

Parameters
Name	Description
request	SendNotificationChannelVerificationCodeRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

updateNotificationChannel(UpdateNotificationChannelRequest request, StreamObserver<NotificationChannel> responseObserver)

public default void updateNotificationChannel(UpdateNotificationChannelRequest request, StreamObserver<NotificationChannel> responseObserver)

Updates a notification channel. Fields not specified in the field mask remain unchanged. Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

Parameters
Name	Description
request	UpdateNotificationChannelRequest
responseObserver	io.grpc.stub.StreamObserver<NotificationChannel>

verifyNotificationChannel(VerifyNotificationChannelRequest request, StreamObserver<NotificationChannel> responseObserver)

public default void verifyNotificationChannel(VerifyNotificationChannelRequest request, StreamObserver<NotificationChannel> responseObserver)

Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

Parameters
Name	Description
request	VerifyNotificationChannelRequest
responseObserver	io.grpc.stub.StreamObserver<NotificationChannel>