Struct gapi_grpc::google::pubsub::v1::PushConfig

pub struct PushConfig {
    pub push_endpoint: String,
    pub attributes: HashMap<String, String>,
    pub authentication_method: Option<AuthenticationMethod>,
}

Configuration for a push delivery endpoint.

Fields

push_endpoint: String

A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

attributes: HashMap<String, String>

Endpoint configuration attributes that can be used to control different aspects of the message delivery.

The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata).

If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute.

The only supported values for the x-goog-version attribute are:

• v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.
• v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API.

For example:

attributes { "x-goog-version": "v1" } 

authentication_method: Option<AuthenticationMethod>

An authentication method used by push endpoints to verify the source of push requests. This can be used with push endpoints that are private by default to allow requests only from the Cloud Pub/Sub system, for example. This field is optional and should be set only by users interested in authenticated push.

Trait Implementations

impl Clone for PushConfig

fn clone(&self) -> PushConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PushConfig

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

Formats the value using the given formatter.

impl Default for PushConfig

fn default() -> PushConfig

Returns the “default value” for a type.

impl Message for PushConfig

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<PushConfig> for PushConfig

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

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

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

This method tests for !=.

impl StructuralPartialEq for PushConfig