Struct google_api_proto::google::monitoring::v3::notification_channel_service_client::NotificationChannelServiceClient

pub struct NotificationChannelServiceClient<T> { /* private fields */ }

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

Implementations

impl<T> NotificationChannelServiceClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F ) -> NotificationChannelServiceClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn list_notification_channel_descriptors( &mut self, request: impl IntoRequest<ListNotificationChannelDescriptorsRequest> ) -> Result<Response<ListNotificationChannelDescriptorsResponse>, Status>

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

pub async fn get_notification_channel_descriptor( &mut self, request: impl IntoRequest<GetNotificationChannelDescriptorRequest> ) -> Result<Response<NotificationChannelDescriptor>, Status>

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

pub async fn list_notification_channels( &mut self, request: impl IntoRequest<ListNotificationChannelsRequest> ) -> Result<Response<ListNotificationChannelsResponse>, Status>

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.

pub async fn get_notification_channel( &mut self, request: impl IntoRequest<GetNotificationChannelRequest> ) -> Result<Response<NotificationChannel>, Status>

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.

pub async fn create_notification_channel( &mut self, request: impl IntoRequest<CreateNotificationChannelRequest> ) -> Result<Response<NotificationChannel>, Status>

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.

pub async fn update_notification_channel( &mut self, request: impl IntoRequest<UpdateNotificationChannelRequest> ) -> Result<Response<NotificationChannel>, Status>

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.

pub async fn delete_notification_channel( &mut self, request: impl IntoRequest<DeleteNotificationChannelRequest> ) -> Result<Response<()>, Status>

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.

pub async fn send_notification_channel_verification_code( &mut self, request: impl IntoRequest<SendNotificationChannelVerificationCodeRequest> ) -> Result<Response<()>, Status>

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

pub async fn get_notification_channel_verification_code( &mut self, request: impl IntoRequest<GetNotificationChannelVerificationCodeRequest> ) -> Result<Response<GetNotificationChannelVerificationCodeResponse>, Status>

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.

pub async fn verify_notification_channel( &mut self, request: impl IntoRequest<VerifyNotificationChannelRequest> ) -> Result<Response<NotificationChannel>, Status>

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

Trait Implementations

impl<T: Clone> Clone for NotificationChannelServiceClient<T>

fn clone(&self) -> NotificationChannelServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for NotificationChannelServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.