Package com.google.monitoring.v3
Class NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub
- java.lang.Object
-
- io.grpc.stub.AbstractStub<S>
-
- io.grpc.stub.AbstractBlockingStub<NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub>
-
- com.google.monitoring.v3.NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub
-
- Enclosing class:
- NotificationChannelServiceGrpc
public static final class NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub extends io.grpc.stub.AbstractBlockingStub<NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub>
A stub to allow clients to do synchronous rpc calls to service NotificationChannelService.The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub
build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
NotificationChannel
createNotificationChannel(CreateNotificationChannelRequest request)
Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.com.google.protobuf.Empty
deleteNotificationChannel(DeleteNotificationChannelRequest request)
Deletes a notification channel.NotificationChannel
getNotificationChannel(GetNotificationChannelRequest request)
Gets a single notification channel.NotificationChannelDescriptor
getNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request)
Gets a single channel descriptor.GetNotificationChannelVerificationCodeResponse
getNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request)
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.ListNotificationChannelDescriptorsResponse
listNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request)
Lists the descriptors for supported channel types.ListNotificationChannelsResponse
listNotificationChannels(ListNotificationChannelsRequest request)
Lists the notification channels that have been created for the project.com.google.protobuf.Empty
sendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request)
Causes a verification code to be delivered to the channel.NotificationChannel
updateNotificationChannel(UpdateNotificationChannelRequest request)
Updates a notification channel.NotificationChannel
verifyNotificationChannel(VerifyNotificationChannelRequest request)
Verifies a `NotificationChannel` by proving receipt of the code delivered to the channel as a result of calling `SendNotificationChannelVerificationCode`.
-
-
-
Method Detail
-
build
protected NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
- Specified by:
build
in classio.grpc.stub.AbstractStub<NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub>
-
listNotificationChannelDescriptors
public ListNotificationChannelDescriptorsResponse 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.
-
getNotificationChannelDescriptor
public 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.
-
listNotificationChannels
public ListNotificationChannelsResponse listNotificationChannels(ListNotificationChannelsRequest request)
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.
-
getNotificationChannel
public 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.
-
createNotificationChannel
public NotificationChannel createNotificationChannel(CreateNotificationChannelRequest request)
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.
-
updateNotificationChannel
public NotificationChannel updateNotificationChannel(UpdateNotificationChannelRequest request)
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.
-
deleteNotificationChannel
public com.google.protobuf.Empty deleteNotificationChannel(DeleteNotificationChannelRequest request)
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.
-
sendNotificationChannelVerificationCode
public com.google.protobuf.Empty sendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request)
Causes a verification code to be delivered to the channel. The code can then be supplied in `VerifyNotificationChannel` to verify the channel.
-
getNotificationChannelVerificationCode
public GetNotificationChannelVerificationCodeResponse getNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request)
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.
-
verifyNotificationChannel
public NotificationChannel verifyNotificationChannel(VerifyNotificationChannelRequest request)
Verifies a `NotificationChannel` by proving receipt of the code delivered to the channel as a result of calling `SendNotificationChannelVerificationCode`.
-
-