Struct PushConfig 

#[non_exhaustive]
pub struct PushConfig {
    pub push_endpoint: String,
    pub attributes: HashMap<String, String>,
    pub authentication_method: Option<AuthenticationMethod>,
    pub wrapper: Option<Wrapper>,
    /* private fields */
}

Configuration for a push delivery endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

push_endpoint: String

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

Optional. 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 Pub/Sub system, for example. This field is optional and should be set only by users interested in authenticated push.

wrapper: Option<Wrapper>

The format of the delivered message to the push endpoint is defined by the chosen wrapper. When unset, PubsubWrapper is used.

Implementations

impl PushConfig

pub fn new() -> Self

pub fn set_push_endpoint<T: Into<String>>(self, v: T) -> Self

Sets the value of push_endpoint.

Example

let x = PushConfig::new().set_push_endpoint("example");

pub fn set_attributes<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of attributes.

Example

let x = PushConfig::new().set_attributes([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_authentication_method<T: Into<Option<AuthenticationMethod>>>( self, v: T, ) -> Self

Sets the value of authentication_method.

Note that all the setters affecting authentication_method are mutually exclusive.

Example

use google_cloud_pubsub::model::push_config::OidcToken;
let x = PushConfig::new().set_authentication_method(Some(
    google_cloud_pubsub::model::push_config::AuthenticationMethod::OidcToken(OidcToken::default().into())));

pub fn oidc_token(&self) -> Option<&Box<OidcToken>>

The value of authentication_method if it holds a OidcToken, None if the field is not set or holds a different branch.

pub fn set_oidc_token<T: Into<Box<OidcToken>>>(self, v: T) -> Self

Sets the value of authentication_method to hold a OidcToken.

Note that all the setters affecting authentication_method are mutually exclusive.

Example

use google_cloud_pubsub::model::push_config::OidcToken;
let x = PushConfig::new().set_oidc_token(OidcToken::default()/* use setters */);
assert!(x.oidc_token().is_some());

pub fn set_wrapper<T: Into<Option<Wrapper>>>(self, v: T) -> Self

Sets the value of wrapper.

Note that all the setters affecting wrapper are mutually exclusive.

Example

use google_cloud_pubsub::model::push_config::PubsubWrapper;
let x = PushConfig::new().set_wrapper(Some(
    google_cloud_pubsub::model::push_config::Wrapper::PubsubWrapper(PubsubWrapper::default().into())));

pub fn pubsub_wrapper(&self) -> Option<&Box<PubsubWrapper>>

The value of wrapper if it holds a PubsubWrapper, None if the field is not set or holds a different branch.

pub fn set_pubsub_wrapper<T: Into<Box<PubsubWrapper>>>(self, v: T) -> Self

Sets the value of wrapper to hold a PubsubWrapper.

Note that all the setters affecting wrapper are mutually exclusive.

Example

use google_cloud_pubsub::model::push_config::PubsubWrapper;
let x = PushConfig::new().set_pubsub_wrapper(PubsubWrapper::default()/* use setters */);
assert!(x.pubsub_wrapper().is_some());
assert!(x.no_wrapper().is_none());

pub fn no_wrapper(&self) -> Option<&Box<NoWrapper>>

The value of wrapper if it holds a NoWrapper, None if the field is not set or holds a different branch.

pub fn set_no_wrapper<T: Into<Box<NoWrapper>>>(self, v: T) -> Self

Sets the value of wrapper to hold a NoWrapper.

Note that all the setters affecting wrapper are mutually exclusive.

Example

use google_cloud_pubsub::model::push_config::NoWrapper;
let x = PushConfig::new().set_no_wrapper(NoWrapper::default()/* use setters */);
assert!(x.no_wrapper().is_some());
assert!(x.pubsub_wrapper().is_none());

Trait Implementations

impl Clone for PushConfig

fn clone(&self) -> PushConfig

Returns a duplicate of the value.

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 typename() -> &'static str

The typename of this message.

impl PartialEq for PushConfig

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PushConfig