Struct google_api_proto::google::storagetransfer::v1::NotificationConfig

pub struct NotificationConfig {
    pub pubsub_topic: String,
    pub event_types: Vec<i32>,
    pub payload_format: i32,
}

Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following PubsubMessage.attributes:

• "eventType": one of the [EventType][google.storagetransfer.v1.NotificationConfig.EventType] values
• "payloadFormat": one of the [PayloadFormat][google.storagetransfer.v1.NotificationConfig.PayloadFormat] values
• "projectId": the [project_id][google.storagetransfer.v1.TransferOperation.project_id] of the TransferOperation
• "transferJobName": the [transfer_job_name][google.storagetransfer.v1.TransferOperation.transfer_job_name] of the TransferOperation
• "transferOperationName": the [name][google.storagetransfer.v1.TransferOperation.name] of the TransferOperation

The PubsubMessage.data contains a [TransferOperation][google.storagetransfer.v1.TransferOperation] resource formatted according to the specified PayloadFormat.

Fields

pubsub_topic: String

Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] error.

event_types: Vec<i32>

Event types for which a notification is desired. If empty, send notifications for all event types.

payload_format: i32

Required. The desired format of the notification message payloads.

Implementations

impl NotificationConfig

pub fn event_types( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<EventType>>

Returns an iterator which yields the valid enum values contained in event_types.

pub fn push_event_types(&mut self, value: EventType)

Appends the provided enum value to event_types.

pub fn payload_format(&self) -> PayloadFormat

Returns the enum value of payload_format, or the default if the field is set to an invalid enum value.

pub fn set_payload_format(&mut self, value: PayloadFormat)

Sets payload_format to the provided enum value.

Trait Implementations

impl Clone for NotificationConfig

fn clone(&self) -> NotificationConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NotificationConfig

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

Formats the value using the given formatter.

impl Default for NotificationConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for NotificationConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for NotificationConfig

fn eq(&self, other: &NotificationConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NotificationConfig