## Subscription

# Struct Subscription

Source

    #[non_exhaustive]pub struct Subscription {Show 21 fields
        pub name: String,
        pub topic: String,
        pub push_config: Option<PushConfig>,
        pub bigquery_config: Option<BigQueryConfig>,
        pub cloud_storage_config: Option<CloudStorageConfig>,
        pub ack_deadline_seconds: i32,
        pub retain_acked_messages: bool,
        pub message_retention_duration: Option<Duration>,
        pub labels: HashMap<String, String>,
        pub enable_message_ordering: bool,
        pub expiration_policy: Option<ExpirationPolicy>,
        pub filter: String,
        pub dead_letter_policy: Option<DeadLetterPolicy>,
        pub retry_policy: Option<RetryPolicy>,
        pub detached: bool,
        pub enable_exactly_once_delivery: bool,
        pub topic_message_retention_duration: Option<Duration>,
        pub state: State,
        pub analytics_hub_subscription_info: Option<AnalyticsHubSubscriptionInfo>,
        pub message_transforms: Vec<MessageTransform>,
        pub tags: HashMap<String, String>,
        /* private fields */
    }

Expand description

A subscription resource. If none of `push_config`, `bigquery_config`, or `cloud_storage_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.

## Fields (Non-exhaustive)§

This struct is marked as 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.
§`name: String`

Required. Identifier. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.

§`topic: String`

Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.

§`push_config: Option<PushConfig>`

Optional. If push delivery is used with this subscription, this field is used to configure it.

§`bigquery_config: Option<BigQueryConfig>`

Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.

§`cloud_storage_config: Option<CloudStorageConfig>`

Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.

§`ack_deadline_seconds: i32`

Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis).

For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

For push delivery, this value is also used to set the request timeout for the call to the push endpoint.

If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

§`retain_acked_messages: bool`

Optional. Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription’s backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.

§`message_retention_duration: Option<Duration>`

Optional. How long to retain unacknowledged messages in the subscription’s backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.

§`labels: HashMap<String, String>`

Optional. See Creating and managing labels.

§`enable_message_ordering: bool`

Optional. If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.

§`expiration_policy: Option<ExpirationPolicy>`

Optional. A policy that specifies the conditions for this subscription’s expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a default policy with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.

§`filter: String`

Optional. An expression written in the Pub/Sub filter language. If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.

§`dead_letter_policy: Option<DeadLetterPolicy>`

Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled.

The Pub/Sub service account associated with this subscriptions’s parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.

§`retry_policy: Option<RetryPolicy>`

Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription.

If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message.

§`detached: bool`

Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don’t receive messages from their topic and don’t retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.

§`enable_exactly_once_delivery: bool`

Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription:

- The message sent to a subscriber is guaranteed not to be resent before the message’s acknowledgment deadline expires.
- An acknowledged message will not be resent to a subscriber.

Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.

§`topic_message_retention_duration: Option<Duration>`

Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription’s topic. If this field is set, messages published to the subscription’s topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.

§`state: State`

Output only. An output-only field indicating whether or not the subscription can receive messages.

§`analytics_hub_subscription_info: Option<AnalyticsHubSubscriptionInfo>`

Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.

§`message_transforms: Vec<MessageTransform>`

Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.

§`tags: HashMap<String, String>`

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: “123/environment”: “production”, “123/costCenter”: “marketing” See https://docs.cloud.google.com/pubsub/docs/tags for more information on using tags with Pub/Sub resources.

## Implementations§

Source§

### impl Subscription

Source

#### pub fn new() -> Self

Source

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

Sets the value of name.

##### §Example

ⓘ

    let x = Subscription::new().set_name("example");

Source

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

Sets the value of topic.

##### §Example

ⓘ

    let x = Subscription::new().set_topic("example");

Source

#### pub fn set_push_config<T>(self, v: T) -> Self
where T: Into<PushConfig>,

Sets the value of push_config.

##### §Example

ⓘ

    use google_cloud_pubsub::model::PushConfig;
    let x = Subscription::new().set_push_config(PushConfig::default()/* use setters */);

Source

#### pub fn set_or_clear_push_config<T>(self, v: Option<T>) -> Self
where T: Into<PushConfig>,

Sets or clears the value of push_config.

##### §Example

ⓘ

    use google_cloud_pubsub::model::PushConfig;
    let x = Subscription::new().set_or_clear_push_config(Some(PushConfig::default()/* use setters */));
    let x = Subscription::new().set_or_clear_push_config(None::<PushConfig>);

Source

#### pub fn set_bigquery_config<T>(self, v: T) -> Self
where T: Into<BigQueryConfig>,

Sets the value of bigquery_config.

##### §Example

ⓘ

    use google_cloud_pubsub::model::BigQueryConfig;
    let x = Subscription::new().set_bigquery_config(BigQueryConfig::default()/* use setters */);

Source

#### pub fn set_or_clear_bigquery_config<T>(self, v: Option<T>) -> Self
where T: Into<BigQueryConfig>,

Sets or clears the value of bigquery_config.

##### §Example

ⓘ

    use google_cloud_pubsub::model::BigQueryConfig;
    let x = Subscription::new().set_or_clear_bigquery_config(Some(BigQueryConfig::default()/* use setters */));
    let x = Subscription::new().set_or_clear_bigquery_config(None::<BigQueryConfig>);

Source

#### pub fn set_cloud_storage_config<T>(self, v: T) -> Self
where T: Into<CloudStorageConfig>,

Sets the value of cloud_storage_config.

##### §Example

ⓘ

    use google_cloud_pubsub::model::CloudStorageConfig;
    let x = Subscription::new().set_cloud_storage_config(CloudStorageConfig::default()/* use setters */);

Source

#### pub fn set_or_clear_cloud_storage_config<T>(self, v: Option<T>) -> Self
where T: Into<CloudStorageConfig>,

Sets or clears the value of cloud_storage_config.

##### §Example

ⓘ

    use google_cloud_pubsub::model::CloudStorageConfig;
    let x = Subscription::new().set_or_clear_cloud_storage_config(Some(CloudStorageConfig::default()/* use setters */));
    let x = Subscription::new().set_or_clear_cloud_storage_config(None::<CloudStorageConfig>);

Source

#### pub fn set_ack_deadline_seconds<T: Into<i32>>(self, v: T) -> Self

Sets the value of ack_deadline_seconds.

##### §Example

ⓘ

    let x = Subscription::new().set_ack_deadline_seconds(42);

Source

#### pub fn set_retain_acked_messages<T: Into<bool>>(self, v: T) -> Self

Sets the value of retain_acked_messages.

##### §Example

ⓘ

    let x = Subscription::new().set_retain_acked_messages(true);

Source

#### pub fn set_message_retention_duration<T>(self, v: T) -> Self
where T: Into<Duration>,

Sets the value of message_retention_duration.

##### §Example

ⓘ

    use wkt::Duration;
    let x = Subscription::new().set_message_retention_duration(Duration::default()/* use setters */);

Source

#### pub fn set_or_clear_message_retention_duration<T>(self, v: Option<T>) -> Self
where T: Into<Duration>,

Sets or clears the value of message_retention_duration.

##### §Example

ⓘ

    use wkt::Duration;
    let x = Subscription::new().set_or_clear_message_retention_duration(Some(Duration::default()/* use setters */));
    let x = Subscription::new().set_or_clear_message_retention_duration(None::<Duration>);

Source

#### pub fn set_labels<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

##### §Example

ⓘ

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

Source

#### pub fn set_enable_message_ordering<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_message_ordering.

##### §Example

ⓘ

    let x = Subscription::new().set_enable_message_ordering(true);

Source

#### pub fn set_expiration_policy<T>(self, v: T) -> Self
where T: Into<ExpirationPolicy>,

Sets the value of expiration_policy.

##### §Example

ⓘ

    use google_cloud_pubsub::model::ExpirationPolicy;
    let x = Subscription::new().set_expiration_policy(ExpirationPolicy::default()/* use setters */);

Source

#### pub fn set_or_clear_expiration_policy<T>(self, v: Option<T>) -> Self
where T: Into<ExpirationPolicy>,

Sets or clears the value of expiration_policy.

##### §Example

ⓘ

    use google_cloud_pubsub::model::ExpirationPolicy;
    let x = Subscription::new().set_or_clear_expiration_policy(Some(ExpirationPolicy::default()/* use setters */));
    let x = Subscription::new().set_or_clear_expiration_policy(None::<ExpirationPolicy>);

Source

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

Sets the value of filter.

##### §Example

ⓘ

    let x = Subscription::new().set_filter("example");

Source

#### pub fn set_dead_letter_policy<T>(self, v: T) -> Self
where T: Into<DeadLetterPolicy>,

Sets the value of dead_letter_policy.

##### §Example

ⓘ

    use google_cloud_pubsub::model::DeadLetterPolicy;
    let x = Subscription::new().set_dead_letter_policy(DeadLetterPolicy::default()/* use setters */);

Source

#### pub fn set_or_clear_dead_letter_policy<T>(self, v: Option<T>) -> Self
where T: Into<DeadLetterPolicy>,

Sets or clears the value of dead_letter_policy.

##### §Example

ⓘ

    use google_cloud_pubsub::model::DeadLetterPolicy;
    let x = Subscription::new().set_or_clear_dead_letter_policy(Some(DeadLetterPolicy::default()/* use setters */));
    let x = Subscription::new().set_or_clear_dead_letter_policy(None::<DeadLetterPolicy>);

Source

#### pub fn set_retry_policy<T>(self, v: T) -> Self
where T: Into<RetryPolicy>,

Sets the value of retry_policy.

##### §Example

ⓘ

    use google_cloud_pubsub::model::RetryPolicy;
    let x = Subscription::new().set_retry_policy(RetryPolicy::default()/* use setters */);

Source

#### pub fn set_or_clear_retry_policy<T>(self, v: Option<T>) -> Self
where T: Into<RetryPolicy>,

Sets or clears the value of retry_policy.

##### §Example

ⓘ

    use google_cloud_pubsub::model::RetryPolicy;
    let x = Subscription::new().set_or_clear_retry_policy(Some(RetryPolicy::default()/* use setters */));
    let x = Subscription::new().set_or_clear_retry_policy(None::<RetryPolicy>);

Source

#### pub fn set_detached<T: Into<bool>>(self, v: T) -> Self

Sets the value of detached.

##### §Example

ⓘ

    let x = Subscription::new().set_detached(true);

Source

#### pub fn set_enable_exactly_once_delivery<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_exactly_once_delivery.

##### §Example

ⓘ

    let x = Subscription::new().set_enable_exactly_once_delivery(true);

Source

#### pub fn set_topic_message_retention_duration<T>(self, v: T) -> Self
where T: Into<Duration>,

Sets the value of topic_message_retention_duration.

##### §Example

ⓘ

    use wkt::Duration;
    let x = Subscription::new().set_topic_message_retention_duration(Duration::default()/* use setters */);

Source

#### pub fn set_or_clear_topic_message_retention_duration<T>( self, v: Option<T>, ) -> Self
where T: Into<Duration>,

Sets or clears the value of topic_message_retention_duration.

##### §Example

ⓘ

    use wkt::Duration;
    let x = Subscription::new().set_or_clear_topic_message_retention_duration(Some(Duration::default()/* use setters */));
    let x = Subscription::new().set_or_clear_topic_message_retention_duration(None::<Duration>);

Source

#### pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

##### §Example

ⓘ

    use google_cloud_pubsub::model::subscription::State;
    let x0 = Subscription::new().set_state(State::Active);
    let x1 = Subscription::new().set_state(State::ResourceError);

Source

#### pub fn set_analytics_hub_subscription_info<T>(self, v: T) -> Self
where T: Into<AnalyticsHubSubscriptionInfo>,

Sets the value of analytics_hub_subscription_info.

##### §Example

ⓘ

    use google_cloud_pubsub::model::subscription::AnalyticsHubSubscriptionInfo;
    let x = Subscription::new().set_analytics_hub_subscription_info(AnalyticsHubSubscriptionInfo::default()/* use setters */);

Source

#### pub fn set_or_clear_analytics_hub_subscription_info<T>( self, v: Option<T>, ) -> Self
where T: Into<AnalyticsHubSubscriptionInfo>,

Sets or clears the value of analytics_hub_subscription_info.

##### §Example

ⓘ

    use google_cloud_pubsub::model::subscription::AnalyticsHubSubscriptionInfo;
    let x = Subscription::new().set_or_clear_analytics_hub_subscription_info(Some(AnalyticsHubSubscriptionInfo::default()/* use setters */));
    let x = Subscription::new().set_or_clear_analytics_hub_subscription_info(None::<AnalyticsHubSubscriptionInfo>);

Source

#### pub fn set_message_transforms<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<MessageTransform>,

Sets the value of message_transforms.

##### §Example

ⓘ

    use google_cloud_pubsub::model::MessageTransform;
    let x = Subscription::new()
        .set_message_transforms([
            MessageTransform::default()/* use setters */,
            MessageTransform::default()/* use (different) setters */,
        ]);

Source

#### pub fn set_tags<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of tags.

##### §Example

ⓘ

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

## Trait Implementations§

Source§

### impl Clone for Subscription

Source§

#### fn clone(&self) -> Subscription

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for Subscription

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl Default for Subscription

Source§

#### fn default() -> Subscription

Returns the “default value” for a type. Read more
Source§

### impl Message for Subscription

Source§

#### fn typename() -> &'static str

The typename of this message.
Source§

### impl PartialEq for Subscription

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl StructuralPartialEq for Subscription

## Auto Trait Implementations§

§

### impl Freeze for Subscription

§

### impl RefUnwindSafe for Subscription

§

### impl Send for Subscription

§

### impl Sync for Subscription

§

### impl Unpin for Subscription

§

### impl UnwindSafe for Subscription

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> IntoRequest<T> for T

§

#### fn into_request(self) -> Request<T>

Wrap the input message `T` in a `tonic::Request`
§

### impl<L> LayerExt<L> for L

§

#### fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [`Layered`].
§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
Source§

### impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,