Class NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub (3.19.0)

public static final class NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub extends 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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

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)

Methods

build(Channel channel, CallOptions callOptions)

protected NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`NotificationChannelServiceGrpc.NotificationChannelServiceBlockingStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createNotificationChannel(CreateNotificationChannelRequest request)

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.

Parameter
Name	Description
`request`	`CreateNotificationChannelRequest`

Returns
Type	Description
`NotificationChannel`

deleteNotificationChannel(DeleteNotificationChannelRequest request)

public Empty deleteNotificationChannel(DeleteNotificationChannelRequest request)

Deletes a notification channel.

Parameter
Name	Description
`request`	`DeleteNotificationChannelRequest`

Returns
Type	Description
`Empty`

getNotificationChannel(GetNotificationChannelRequest request)

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.

Parameter
Name	Description
`request`	`GetNotificationChannelRequest`

Returns
Type	Description
`NotificationChannel`

getNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request)

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.

Parameter
Name	Description
`request`	`GetNotificationChannelDescriptorRequest`

Returns
Type	Description
`NotificationChannelDescriptor`

getNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request)

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.

Parameter
Name	Description
`request`	`GetNotificationChannelVerificationCodeRequest`

Returns
Type	Description
`GetNotificationChannelVerificationCodeResponse`

listNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request)

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.

Parameter
Name	Description
`request`	`ListNotificationChannelDescriptorsRequest`

Returns
Type	Description
`ListNotificationChannelDescriptorsResponse`

listNotificationChannels(ListNotificationChannelsRequest request)

public ListNotificationChannelsResponse listNotificationChannels(ListNotificationChannelsRequest request)

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

Parameter
Name	Description
`request`	`ListNotificationChannelsRequest`

Returns
Type	Description
`ListNotificationChannelsResponse`

sendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request)

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

Parameter
Name	Description
`request`	`SendNotificationChannelVerificationCodeRequest`

Returns
Type	Description
`Empty`

updateNotificationChannel(UpdateNotificationChannelRequest request)

public NotificationChannel updateNotificationChannel(UpdateNotificationChannelRequest request)

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

Parameter
Name	Description
`request`	`UpdateNotificationChannelRequest`

Returns
Type	Description
`NotificationChannel`

verifyNotificationChannel(VerifyNotificationChannelRequest request)

public NotificationChannel verifyNotificationChannel(VerifyNotificationChannelRequest request)

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

Parameter
Name	Description
`request`	`VerifyNotificationChannelRequest`

Returns
Type	Description
`NotificationChannel`