google-apps-events-subscriptions-v1 1.1.0

// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by sidekick. DO NOT EDIT.

#![allow(rustdoc::bare_urls)]
#![allow(rustdoc::broken_intra_doc_links)]
#![allow(rustdoc::invalid_html_tags)]
#![allow(rustdoc::redundant_explicit_links)]
#![no_implicit_prelude]
extern crate async_trait;
extern crate bytes;
extern crate gaxi;
extern crate google_cloud_gax;
extern crate google_cloud_longrunning;
extern crate google_cloud_lro;
extern crate serde;
extern crate serde_json;
extern crate serde_with;
extern crate std;
extern crate tracing;
extern crate wkt;

mod debug;
mod deserialize;
mod serialize;

/// A subscription to receive events about a Google Workspace resource. To learn
/// more about subscriptions, see the [Google Workspace Events API
/// overview](https://developers.google.com/workspace/events).
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct Subscription {
    /// Optional. Immutable. Identifier. Resource name of the subscription.
    ///
    /// Format: `subscriptions/{subscription}`
    pub name: std::string::String,

    /// Output only. System-assigned unique identifier for the subscription.
    pub uid: std::string::String,

    /// Required. Immutable. The Google Workspace resource that's monitored for
    /// events, formatted as the [full resource
    /// name](https://google.aip.dev/122#full-resource-names). To learn about
    /// target resources and the events that they support, see [Supported Google
    /// Workspace
    /// events](https://developers.google.com/workspace/events#supported-events).
    ///
    /// A user can only authorize your app to create one subscription for a given
    /// target resource. If your app tries to create another subscription with the
    /// same user credentials, the request returns an `ALREADY_EXISTS` error.
    pub target_resource: std::string::String,

    /// Required. Immutable. Unordered list. Input for creating a subscription.
    /// Otherwise, output only. One or more types of events to receive about the
    /// target resource. Formatted according to the CloudEvents specification.
    ///
    /// The supported event types depend on the target resource of your
    /// subscription. For details, see [Supported Google Workspace
    /// events](https://developers.google.com/workspace/events/guides#supported-events).
    ///
    /// By default, you also receive events about the [lifecycle of your
    /// subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
    /// You don't need to specify lifecycle events for this field.
    ///
    /// If you specify an event type that doesn't exist for the target resource,
    /// the request returns an HTTP `400 Bad Request` status code.
    pub event_types: std::vec::Vec<std::string::String>,

    /// Optional. Options about what data to include in the event payload. Only
    /// supported for Google Chat events.
    pub payload_options: std::option::Option<crate::model::PayloadOptions>,

    /// Required. Immutable. The endpoint where the subscription delivers events,
    /// such as a Pub/Sub topic.
    pub notification_endpoint: std::option::Option<crate::model::NotificationEndpoint>,

    /// Output only. The state of the subscription. Determines whether the
    /// subscription can receive events and deliver them to the notification
    /// endpoint.
    pub state: crate::model::subscription::State,

    /// Output only. The error that suspended the subscription.
    ///
    /// To reactivate the subscription, resolve the error and call the
    /// [`ReactivateSubscription`][google.apps.events.subscriptions.v1.SubscriptionsService.ReactivateSubscription]
    /// method.
    ///
    /// [google.apps.events.subscriptions.v1.SubscriptionsService.ReactivateSubscription]: crate::client::SubscriptionsService::reactivate_subscription
    pub suspension_reason: crate::model::subscription::ErrorType,

    /// Output only. The user who authorized the creation of the
    /// subscription.
    ///
    /// Format: `users/{user}`
    ///
    /// For Google Workspace users, the `{user}` value is the
    /// [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids)
    /// field from the Directory API.
    pub authority: std::string::String,

    /// Output only. The time when the subscription is created.
    pub create_time: std::option::Option<wkt::Timestamp>,

    /// Output only. The last time that the subscription is updated.
    pub update_time: std::option::Option<wkt::Timestamp>,

    /// Output only. If `true`, the subscription is in the process of being
    /// updated.
    pub reconciling: bool,

    /// Optional. This checksum is computed by the server based on the value of
    /// other fields, and might be sent on update requests to ensure the client has
    /// an up-to-date value before proceeding.
    pub etag: std::string::String,

    /// The time when the subscription expires.
    ///
    /// The maximum expiration time depends on whether your subscription includes
    /// resource data in event payloads (specified in the
    /// [PayloadOptions][google.apps.events.subscriptions.v1.PayloadOptions]
    /// field):
    ///
    /// * If payloads omit resource data, up to 7 days.
    /// * If payloads include resource data, up to 4 hours. If your Google
    ///   Workspace organization grants access to the resource through [domain-wide
    ///   delegation](https://support.google.com/a/answer/162106), you can extend the
    ///   subscription's expiration time to up to 24 hours.
    ///
    /// After a subscription expires, it's deleted automatically. You receive
    /// lifecycle events to the
    /// [notification_endpoint][google.apps.events.subscriptions.v1.Subscription.notification_endpoint]
    /// 12 hours and one hour before the subscription expires. For details, see
    /// [Receive and respond to lifecycle
    /// events](https://developers.google.com/workspace/events/guides/events-lifecycle).
    ///
    /// To prevent a subscription from expiring, you can use the
    /// [`UpdateSubscription`][google.apps.events.subscriptions.v1.SubscriptionsService.UpdateSubscription]
    /// method to extend its expiration date. For details, see [Update or renew a
    /// subscription](https://developers.google.com/workspace/events/guides/update-subscription).
    ///
    /// [google.apps.events.subscriptions.v1.PayloadOptions]: crate::model::PayloadOptions
    /// [google.apps.events.subscriptions.v1.Subscription.notification_endpoint]: crate::model::Subscription::notification_endpoint
    /// [google.apps.events.subscriptions.v1.SubscriptionsService.UpdateSubscription]: crate::client::SubscriptionsService::update_subscription
    pub expiration: std::option::Option<crate::model::subscription::Expiration>,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl Subscription {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [name][crate::model::Subscription::name].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// # let subscription_id = "subscription_id";
    /// let x = Subscription::new().set_name(format!("subscriptions/{subscription_id}"));
    /// ```
    pub fn set_name<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.name = v.into();
        self
    }

    /// Sets the value of [uid][crate::model::Subscription::uid].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = Subscription::new().set_uid("example");
    /// ```
    pub fn set_uid<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.uid = v.into();
        self
    }

    /// Sets the value of [target_resource][crate::model::Subscription::target_resource].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = Subscription::new().set_target_resource("example");
    /// ```
    pub fn set_target_resource<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.target_resource = v.into();
        self
    }

    /// Sets the value of [event_types][crate::model::Subscription::event_types].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = Subscription::new().set_event_types(["a", "b", "c"]);
    /// ```
    pub fn set_event_types<T, V>(mut self, v: T) -> Self
    where
        T: std::iter::IntoIterator<Item = V>,
        V: std::convert::Into<std::string::String>,
    {
        use std::iter::Iterator;
        self.event_types = v.into_iter().map(|i| i.into()).collect();
        self
    }

    /// Sets the value of [payload_options][crate::model::Subscription::payload_options].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use google_apps_events_subscriptions_v1::model::PayloadOptions;
    /// let x = Subscription::new().set_payload_options(PayloadOptions::default()/* use setters */);
    /// ```
    pub fn set_payload_options<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<crate::model::PayloadOptions>,
    {
        self.payload_options = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [payload_options][crate::model::Subscription::payload_options].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use google_apps_events_subscriptions_v1::model::PayloadOptions;
    /// let x = Subscription::new().set_or_clear_payload_options(Some(PayloadOptions::default()/* use setters */));
    /// let x = Subscription::new().set_or_clear_payload_options(None::<PayloadOptions>);
    /// ```
    pub fn set_or_clear_payload_options<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<crate::model::PayloadOptions>,
    {
        self.payload_options = v.map(|x| x.into());
        self
    }

    /// Sets the value of [notification_endpoint][crate::model::Subscription::notification_endpoint].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use google_apps_events_subscriptions_v1::model::NotificationEndpoint;
    /// let x = Subscription::new().set_notification_endpoint(NotificationEndpoint::default()/* use setters */);
    /// ```
    pub fn set_notification_endpoint<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<crate::model::NotificationEndpoint>,
    {
        self.notification_endpoint = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [notification_endpoint][crate::model::Subscription::notification_endpoint].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use google_apps_events_subscriptions_v1::model::NotificationEndpoint;
    /// let x = Subscription::new().set_or_clear_notification_endpoint(Some(NotificationEndpoint::default()/* use setters */));
    /// let x = Subscription::new().set_or_clear_notification_endpoint(None::<NotificationEndpoint>);
    /// ```
    pub fn set_or_clear_notification_endpoint<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<crate::model::NotificationEndpoint>,
    {
        self.notification_endpoint = v.map(|x| x.into());
        self
    }

    /// Sets the value of [state][crate::model::Subscription::state].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use google_apps_events_subscriptions_v1::model::subscription::State;
    /// let x0 = Subscription::new().set_state(State::Active);
    /// let x1 = Subscription::new().set_state(State::Suspended);
    /// let x2 = Subscription::new().set_state(State::Deleted);
    /// ```
    pub fn set_state<T: std::convert::Into<crate::model::subscription::State>>(
        mut self,
        v: T,
    ) -> Self {
        self.state = v.into();
        self
    }

    /// Sets the value of [suspension_reason][crate::model::Subscription::suspension_reason].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use google_apps_events_subscriptions_v1::model::subscription::ErrorType;
    /// let x0 = Subscription::new().set_suspension_reason(ErrorType::UserScopeRevoked);
    /// let x1 = Subscription::new().set_suspension_reason(ErrorType::ResourceDeleted);
    /// let x2 = Subscription::new().set_suspension_reason(ErrorType::UserAuthorizationFailure);
    /// ```
    pub fn set_suspension_reason<T: std::convert::Into<crate::model::subscription::ErrorType>>(
        mut self,
        v: T,
    ) -> Self {
        self.suspension_reason = v.into();
        self
    }

    /// Sets the value of [authority][crate::model::Subscription::authority].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = Subscription::new().set_authority("example");
    /// ```
    pub fn set_authority<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.authority = v.into();
        self
    }

    /// Sets the value of [create_time][crate::model::Subscription::create_time].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use wkt::Timestamp;
    /// let x = Subscription::new().set_create_time(Timestamp::default()/* use setters */);
    /// ```
    pub fn set_create_time<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<wkt::Timestamp>,
    {
        self.create_time = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [create_time][crate::model::Subscription::create_time].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use wkt::Timestamp;
    /// let x = Subscription::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
    /// let x = Subscription::new().set_or_clear_create_time(None::<Timestamp>);
    /// ```
    pub fn set_or_clear_create_time<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<wkt::Timestamp>,
    {
        self.create_time = v.map(|x| x.into());
        self
    }

    /// Sets the value of [update_time][crate::model::Subscription::update_time].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use wkt::Timestamp;
    /// let x = Subscription::new().set_update_time(Timestamp::default()/* use setters */);
    /// ```
    pub fn set_update_time<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<wkt::Timestamp>,
    {
        self.update_time = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [update_time][crate::model::Subscription::update_time].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use wkt::Timestamp;
    /// let x = Subscription::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
    /// let x = Subscription::new().set_or_clear_update_time(None::<Timestamp>);
    /// ```
    pub fn set_or_clear_update_time<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<wkt::Timestamp>,
    {
        self.update_time = v.map(|x| x.into());
        self
    }

    /// Sets the value of [reconciling][crate::model::Subscription::reconciling].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = Subscription::new().set_reconciling(true);
    /// ```
    pub fn set_reconciling<T: std::convert::Into<bool>>(mut self, v: T) -> Self {
        self.reconciling = v.into();
        self
    }

    /// Sets the value of [etag][crate::model::Subscription::etag].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = Subscription::new().set_etag("example");
    /// ```
    pub fn set_etag<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.etag = v.into();
        self
    }

    /// Sets the value of [expiration][crate::model::Subscription::expiration].
    ///
    /// Note that all the setters affecting `expiration` are mutually
    /// exclusive.
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use wkt::Timestamp;
    /// let x = Subscription::new().set_expiration(Some(
    ///     google_apps_events_subscriptions_v1::model::subscription::Expiration::ExpireTime(Timestamp::default().into())));
    /// ```
    pub fn set_expiration<
        T: std::convert::Into<std::option::Option<crate::model::subscription::Expiration>>,
    >(
        mut self,
        v: T,
    ) -> Self {
        self.expiration = v.into();
        self
    }

    /// The value of [expiration][crate::model::Subscription::expiration]
    /// if it holds a `ExpireTime`, `None` if the field is not set or
    /// holds a different branch.
    pub fn expire_time(&self) -> std::option::Option<&std::boxed::Box<wkt::Timestamp>> {
        #[allow(unreachable_patterns)]
        self.expiration.as_ref().and_then(|v| match v {
            crate::model::subscription::Expiration::ExpireTime(v) => std::option::Option::Some(v),
            _ => std::option::Option::None,
        })
    }

    /// Sets the value of [expiration][crate::model::Subscription::expiration]
    /// to hold a `ExpireTime`.
    ///
    /// Note that all the setters affecting `expiration` are
    /// mutually exclusive.
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use wkt::Timestamp;
    /// let x = Subscription::new().set_expire_time(Timestamp::default()/* use setters */);
    /// assert!(x.expire_time().is_some());
    /// assert!(x.ttl().is_none());
    /// ```
    pub fn set_expire_time<T: std::convert::Into<std::boxed::Box<wkt::Timestamp>>>(
        mut self,
        v: T,
    ) -> Self {
        self.expiration =
            std::option::Option::Some(crate::model::subscription::Expiration::ExpireTime(v.into()));
        self
    }

    /// The value of [expiration][crate::model::Subscription::expiration]
    /// if it holds a `Ttl`, `None` if the field is not set or
    /// holds a different branch.
    pub fn ttl(&self) -> std::option::Option<&std::boxed::Box<wkt::Duration>> {
        #[allow(unreachable_patterns)]
        self.expiration.as_ref().and_then(|v| match v {
            crate::model::subscription::Expiration::Ttl(v) => std::option::Option::Some(v),
            _ => std::option::Option::None,
        })
    }

    /// Sets the value of [expiration][crate::model::Subscription::expiration]
    /// to hold a `Ttl`.
    ///
    /// Note that all the setters affecting `expiration` are
    /// mutually exclusive.
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::Subscription;
    /// use wkt::Duration;
    /// let x = Subscription::new().set_ttl(Duration::default()/* use setters */);
    /// assert!(x.ttl().is_some());
    /// assert!(x.expire_time().is_none());
    /// ```
    pub fn set_ttl<T: std::convert::Into<std::boxed::Box<wkt::Duration>>>(mut self, v: T) -> Self {
        self.expiration =
            std::option::Option::Some(crate::model::subscription::Expiration::Ttl(v.into()));
        self
    }
}

impl wkt::message::Message for Subscription {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.Subscription"
    }
}

/// Defines additional types related to [Subscription].
pub mod subscription {
    #[allow(unused_imports)]
    use super::*;

    /// Possible states for the subscription.
    ///
    /// # Working with unknown values
    ///
    /// This enum is defined as `#[non_exhaustive]` because Google Cloud may add
    /// additional enum variants at any time. Adding new variants is not considered
    /// a breaking change. Applications should write their code in anticipation of:
    ///
    /// - New values appearing in future releases of the client library, **and**
    /// - New values received dynamically, without application changes.
    ///
    /// Please consult the [Working with enums] section in the user guide for some
    /// guidelines.
    ///
    /// [Working with enums]: https://googleapis.github.io/google-cloud-rust/working_with_enums.html
    #[derive(Clone, Debug, PartialEq)]
    #[non_exhaustive]
    pub enum State {
        /// Default value. This value is unused.
        Unspecified,
        /// The subscription is active and can receive and deliver events to its
        /// notification endpoint.
        Active,
        /// The subscription is unable to receive events due to an error.
        /// To identify the error, see the
        /// [`suspension_reason`][google.apps.events.subscriptions.v1.Subscription.suspension_reason]
        /// field.
        ///
        /// [google.apps.events.subscriptions.v1.Subscription.suspension_reason]: crate::model::Subscription::suspension_reason
        Suspended,
        /// The subscription is deleted.
        Deleted,
        /// If set, the enum was initialized with an unknown value.
        ///
        /// Applications can examine the value using [State::value] or
        /// [State::name].
        UnknownValue(state::UnknownValue),
    }

    #[doc(hidden)]
    pub mod state {
        #[allow(unused_imports)]
        use super::*;
        #[derive(Clone, Debug, PartialEq)]
        pub struct UnknownValue(pub(crate) wkt::internal::UnknownEnumValue);
    }

    impl State {
        /// Gets the enum value.
        ///
        /// Returns `None` if the enum contains an unknown value deserialized from
        /// the string representation of enums.
        pub fn value(&self) -> std::option::Option<i32> {
            match self {
                Self::Unspecified => std::option::Option::Some(0),
                Self::Active => std::option::Option::Some(1),
                Self::Suspended => std::option::Option::Some(2),
                Self::Deleted => std::option::Option::Some(3),
                Self::UnknownValue(u) => u.0.value(),
            }
        }

        /// Gets the enum value as a string.
        ///
        /// Returns `None` if the enum contains an unknown value deserialized from
        /// the integer representation of enums.
        pub fn name(&self) -> std::option::Option<&str> {
            match self {
                Self::Unspecified => std::option::Option::Some("STATE_UNSPECIFIED"),
                Self::Active => std::option::Option::Some("ACTIVE"),
                Self::Suspended => std::option::Option::Some("SUSPENDED"),
                Self::Deleted => std::option::Option::Some("DELETED"),
                Self::UnknownValue(u) => u.0.name(),
            }
        }
    }

    impl std::default::Default for State {
        fn default() -> Self {
            use std::convert::From;
            Self::from(0)
        }
    }

    impl std::fmt::Display for State {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::result::Result<(), std::fmt::Error> {
            wkt::internal::display_enum(f, self.name(), self.value())
        }
    }

    impl std::convert::From<i32> for State {
        fn from(value: i32) -> Self {
            match value {
                0 => Self::Unspecified,
                1 => Self::Active,
                2 => Self::Suspended,
                3 => Self::Deleted,
                _ => Self::UnknownValue(state::UnknownValue(
                    wkt::internal::UnknownEnumValue::Integer(value),
                )),
            }
        }
    }

    impl std::convert::From<&str> for State {
        fn from(value: &str) -> Self {
            use std::string::ToString;
            match value {
                "STATE_UNSPECIFIED" => Self::Unspecified,
                "ACTIVE" => Self::Active,
                "SUSPENDED" => Self::Suspended,
                "DELETED" => Self::Deleted,
                _ => Self::UnknownValue(state::UnknownValue(
                    wkt::internal::UnknownEnumValue::String(value.to_string()),
                )),
            }
        }
    }

    impl serde::ser::Serialize for State {
        fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
        where
            S: serde::Serializer,
        {
            match self {
                Self::Unspecified => serializer.serialize_i32(0),
                Self::Active => serializer.serialize_i32(1),
                Self::Suspended => serializer.serialize_i32(2),
                Self::Deleted => serializer.serialize_i32(3),
                Self::UnknownValue(u) => u.0.serialize(serializer),
            }
        }
    }

    impl<'de> serde::de::Deserialize<'de> for State {
        fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
        where
            D: serde::Deserializer<'de>,
        {
            deserializer.deserialize_any(wkt::internal::EnumVisitor::<State>::new(
                ".google.apps.events.subscriptions.v1.Subscription.State",
            ))
        }
    }

    /// Possible errors for a subscription.
    ///
    /// # Working with unknown values
    ///
    /// This enum is defined as `#[non_exhaustive]` because Google Cloud may add
    /// additional enum variants at any time. Adding new variants is not considered
    /// a breaking change. Applications should write their code in anticipation of:
    ///
    /// - New values appearing in future releases of the client library, **and**
    /// - New values received dynamically, without application changes.
    ///
    /// Please consult the [Working with enums] section in the user guide for some
    /// guidelines.
    ///
    /// [Working with enums]: https://googleapis.github.io/google-cloud-rust/working_with_enums.html
    #[derive(Clone, Debug, PartialEq)]
    #[non_exhaustive]
    pub enum ErrorType {
        /// Default value. This value is unused.
        Unspecified,
        /// The authorizing user has revoked the grant of one or more OAuth scopes.
        /// To learn more about authorization for Google Workspace, see [Configure
        /// the OAuth consent
        /// screen](https://developers.google.com/workspace/guides/configure-oauth-consent#choose-scopes).
        UserScopeRevoked,
        /// The target resource for the subscription no longer exists.
        ResourceDeleted,
        /// The user that authorized the creation of the subscription no longer has
        /// access to the subscription's target resource.
        UserAuthorizationFailure,
        /// The Google Workspace application doesn't have access to deliver
        /// events to your subscription's notification endpoint.
        EndpointPermissionDenied,
        /// The subscription's notification endpoint doesn't exist, or the endpoint
        /// can't be found in the Google Cloud project where you created the
        /// subscription.
        EndpointNotFound,
        /// The subscription's notification endpoint failed to receive events due to
        /// insufficient quota or reaching rate limiting.
        EndpointResourceExhausted,
        /// An unidentified error has occurred.
        Other,
        /// If set, the enum was initialized with an unknown value.
        ///
        /// Applications can examine the value using [ErrorType::value] or
        /// [ErrorType::name].
        UnknownValue(error_type::UnknownValue),
    }

    #[doc(hidden)]
    pub mod error_type {
        #[allow(unused_imports)]
        use super::*;
        #[derive(Clone, Debug, PartialEq)]
        pub struct UnknownValue(pub(crate) wkt::internal::UnknownEnumValue);
    }

    impl ErrorType {
        /// Gets the enum value.
        ///
        /// Returns `None` if the enum contains an unknown value deserialized from
        /// the string representation of enums.
        pub fn value(&self) -> std::option::Option<i32> {
            match self {
                Self::Unspecified => std::option::Option::Some(0),
                Self::UserScopeRevoked => std::option::Option::Some(1),
                Self::ResourceDeleted => std::option::Option::Some(2),
                Self::UserAuthorizationFailure => std::option::Option::Some(3),
                Self::EndpointPermissionDenied => std::option::Option::Some(4),
                Self::EndpointNotFound => std::option::Option::Some(6),
                Self::EndpointResourceExhausted => std::option::Option::Some(7),
                Self::Other => std::option::Option::Some(5),
                Self::UnknownValue(u) => u.0.value(),
            }
        }

        /// Gets the enum value as a string.
        ///
        /// Returns `None` if the enum contains an unknown value deserialized from
        /// the integer representation of enums.
        pub fn name(&self) -> std::option::Option<&str> {
            match self {
                Self::Unspecified => std::option::Option::Some("ERROR_TYPE_UNSPECIFIED"),
                Self::UserScopeRevoked => std::option::Option::Some("USER_SCOPE_REVOKED"),
                Self::ResourceDeleted => std::option::Option::Some("RESOURCE_DELETED"),
                Self::UserAuthorizationFailure => {
                    std::option::Option::Some("USER_AUTHORIZATION_FAILURE")
                }
                Self::EndpointPermissionDenied => {
                    std::option::Option::Some("ENDPOINT_PERMISSION_DENIED")
                }
                Self::EndpointNotFound => std::option::Option::Some("ENDPOINT_NOT_FOUND"),
                Self::EndpointResourceExhausted => {
                    std::option::Option::Some("ENDPOINT_RESOURCE_EXHAUSTED")
                }
                Self::Other => std::option::Option::Some("OTHER"),
                Self::UnknownValue(u) => u.0.name(),
            }
        }
    }

    impl std::default::Default for ErrorType {
        fn default() -> Self {
            use std::convert::From;
            Self::from(0)
        }
    }

    impl std::fmt::Display for ErrorType {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::result::Result<(), std::fmt::Error> {
            wkt::internal::display_enum(f, self.name(), self.value())
        }
    }

    impl std::convert::From<i32> for ErrorType {
        fn from(value: i32) -> Self {
            match value {
                0 => Self::Unspecified,
                1 => Self::UserScopeRevoked,
                2 => Self::ResourceDeleted,
                3 => Self::UserAuthorizationFailure,
                4 => Self::EndpointPermissionDenied,
                5 => Self::Other,
                6 => Self::EndpointNotFound,
                7 => Self::EndpointResourceExhausted,
                _ => Self::UnknownValue(error_type::UnknownValue(
                    wkt::internal::UnknownEnumValue::Integer(value),
                )),
            }
        }
    }

    impl std::convert::From<&str> for ErrorType {
        fn from(value: &str) -> Self {
            use std::string::ToString;
            match value {
                "ERROR_TYPE_UNSPECIFIED" => Self::Unspecified,
                "USER_SCOPE_REVOKED" => Self::UserScopeRevoked,
                "RESOURCE_DELETED" => Self::ResourceDeleted,
                "USER_AUTHORIZATION_FAILURE" => Self::UserAuthorizationFailure,
                "ENDPOINT_PERMISSION_DENIED" => Self::EndpointPermissionDenied,
                "ENDPOINT_NOT_FOUND" => Self::EndpointNotFound,
                "ENDPOINT_RESOURCE_EXHAUSTED" => Self::EndpointResourceExhausted,
                "OTHER" => Self::Other,
                _ => Self::UnknownValue(error_type::UnknownValue(
                    wkt::internal::UnknownEnumValue::String(value.to_string()),
                )),
            }
        }
    }

    impl serde::ser::Serialize for ErrorType {
        fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
        where
            S: serde::Serializer,
        {
            match self {
                Self::Unspecified => serializer.serialize_i32(0),
                Self::UserScopeRevoked => serializer.serialize_i32(1),
                Self::ResourceDeleted => serializer.serialize_i32(2),
                Self::UserAuthorizationFailure => serializer.serialize_i32(3),
                Self::EndpointPermissionDenied => serializer.serialize_i32(4),
                Self::EndpointNotFound => serializer.serialize_i32(6),
                Self::EndpointResourceExhausted => serializer.serialize_i32(7),
                Self::Other => serializer.serialize_i32(5),
                Self::UnknownValue(u) => u.0.serialize(serializer),
            }
        }
    }

    impl<'de> serde::de::Deserialize<'de> for ErrorType {
        fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
        where
            D: serde::Deserializer<'de>,
        {
            deserializer.deserialize_any(wkt::internal::EnumVisitor::<ErrorType>::new(
                ".google.apps.events.subscriptions.v1.Subscription.ErrorType",
            ))
        }
    }

    /// The time when the subscription expires.
    ///
    /// The maximum expiration time depends on whether your subscription includes
    /// resource data in event payloads (specified in the
    /// [PayloadOptions][google.apps.events.subscriptions.v1.PayloadOptions]
    /// field):
    ///
    /// * If payloads omit resource data, up to 7 days.
    /// * If payloads include resource data, up to 4 hours. If your Google
    ///   Workspace organization grants access to the resource through [domain-wide
    ///   delegation](https://support.google.com/a/answer/162106), you can extend the
    ///   subscription's expiration time to up to 24 hours.
    ///
    /// After a subscription expires, it's deleted automatically. You receive
    /// lifecycle events to the
    /// [notification_endpoint][google.apps.events.subscriptions.v1.Subscription.notification_endpoint]
    /// 12 hours and one hour before the subscription expires. For details, see
    /// [Receive and respond to lifecycle
    /// events](https://developers.google.com/workspace/events/guides/events-lifecycle).
    ///
    /// To prevent a subscription from expiring, you can use the
    /// [`UpdateSubscription`][google.apps.events.subscriptions.v1.SubscriptionsService.UpdateSubscription]
    /// method to extend its expiration date. For details, see [Update or renew a
    /// subscription](https://developers.google.com/workspace/events/guides/update-subscription).
    ///
    /// [google.apps.events.subscriptions.v1.PayloadOptions]: crate::model::PayloadOptions
    /// [google.apps.events.subscriptions.v1.Subscription.notification_endpoint]: crate::model::Subscription::notification_endpoint
    /// [google.apps.events.subscriptions.v1.SubscriptionsService.UpdateSubscription]: crate::client::SubscriptionsService::update_subscription
    #[derive(Clone, Debug, PartialEq)]
    #[non_exhaustive]
    pub enum Expiration {
        /// Non-empty default. The timestamp in UTC when the subscription expires.
        /// Always displayed on output, regardless of what was used on input.
        ExpireTime(std::boxed::Box<wkt::Timestamp>),
        /// Input only. The time-to-live (TTL) or duration for the subscription. If
        /// unspecified or set to `0`, uses the maximum possible duration.
        Ttl(std::boxed::Box<wkt::Duration>),
    }
}

/// Options about what data to include in the event payload. Only supported for
/// Google Chat events.
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct PayloadOptions {
    /// Optional. Whether the event payload includes data about the resource that
    /// changed. For example, for an event where a Google Chat message was created,
    /// whether the payload contains data about the
    /// [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages)
    /// resource. If false, the event payload only includes the name of the changed
    /// resource.
    pub include_resource: bool,

    /// Optional. If `include_resource` is set to `true`, the list of fields to
    /// include in the event payload. Separate fields with a comma. For example, to
    /// include a Google Chat message's sender and create time, enter
    /// `message.sender,message.createTime`. If omitted, the payload includes all
    /// fields for the resource.
    ///
    /// If you specify a field that doesn't exist for the resource, the system
    /// ignores the field.
    pub field_mask: std::option::Option<wkt::FieldMask>,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl PayloadOptions {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [include_resource][crate::model::PayloadOptions::include_resource].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::PayloadOptions;
    /// let x = PayloadOptions::new().set_include_resource(true);
    /// ```
    pub fn set_include_resource<T: std::convert::Into<bool>>(mut self, v: T) -> Self {
        self.include_resource = v.into();
        self
    }

    /// Sets the value of [field_mask][crate::model::PayloadOptions::field_mask].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::PayloadOptions;
    /// use wkt::FieldMask;
    /// let x = PayloadOptions::new().set_field_mask(FieldMask::default()/* use setters */);
    /// ```
    pub fn set_field_mask<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<wkt::FieldMask>,
    {
        self.field_mask = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [field_mask][crate::model::PayloadOptions::field_mask].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::PayloadOptions;
    /// use wkt::FieldMask;
    /// let x = PayloadOptions::new().set_or_clear_field_mask(Some(FieldMask::default()/* use setters */));
    /// let x = PayloadOptions::new().set_or_clear_field_mask(None::<FieldMask>);
    /// ```
    pub fn set_or_clear_field_mask<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<wkt::FieldMask>,
    {
        self.field_mask = v.map(|x| x.into());
        self
    }
}

impl wkt::message::Message for PayloadOptions {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.PayloadOptions"
    }
}

/// The endpoint where the subscription delivers events.
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct NotificationEndpoint {
    #[allow(missing_docs)]
    pub endpoint: std::option::Option<crate::model::notification_endpoint::Endpoint>,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl NotificationEndpoint {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [endpoint][crate::model::NotificationEndpoint::endpoint].
    ///
    /// Note that all the setters affecting `endpoint` are mutually
    /// exclusive.
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::NotificationEndpoint;
    /// use google_apps_events_subscriptions_v1::model::notification_endpoint::Endpoint;
    /// let x = NotificationEndpoint::new().set_endpoint(Some(Endpoint::PubsubTopic("example".to_string())));
    /// ```
    pub fn set_endpoint<
        T: std::convert::Into<std::option::Option<crate::model::notification_endpoint::Endpoint>>,
    >(
        mut self,
        v: T,
    ) -> Self {
        self.endpoint = v.into();
        self
    }

    /// The value of [endpoint][crate::model::NotificationEndpoint::endpoint]
    /// if it holds a `PubsubTopic`, `None` if the field is not set or
    /// holds a different branch.
    pub fn pubsub_topic(&self) -> std::option::Option<&std::string::String> {
        #[allow(unreachable_patterns)]
        self.endpoint.as_ref().and_then(|v| match v {
            crate::model::notification_endpoint::Endpoint::PubsubTopic(v) => {
                std::option::Option::Some(v)
            }
            _ => std::option::Option::None,
        })
    }

    /// Sets the value of [endpoint][crate::model::NotificationEndpoint::endpoint]
    /// to hold a `PubsubTopic`.
    ///
    /// Note that all the setters affecting `endpoint` are
    /// mutually exclusive.
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::NotificationEndpoint;
    /// let x = NotificationEndpoint::new().set_pubsub_topic("example");
    /// assert!(x.pubsub_topic().is_some());
    /// ```
    pub fn set_pubsub_topic<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.endpoint = std::option::Option::Some(
            crate::model::notification_endpoint::Endpoint::PubsubTopic(v.into()),
        );
        self
    }
}

impl wkt::message::Message for NotificationEndpoint {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.NotificationEndpoint"
    }
}

/// Defines additional types related to [NotificationEndpoint].
pub mod notification_endpoint {
    #[allow(unused_imports)]
    use super::*;

    #[allow(missing_docs)]
    #[derive(Clone, Debug, PartialEq)]
    #[non_exhaustive]
    pub enum Endpoint {
        /// Immutable. The Cloud Pub/Sub topic that receives events for the
        /// subscription.
        ///
        /// Format: `projects/{project}/topics/{topic}`
        ///
        /// You must create the topic in the same Google Cloud project where
        /// you create this subscription.
        ///
        /// When the topic receives events, the events are encoded as Cloud Pub/Sub
        /// messages. For details, see the [Google Cloud Pub/Sub Protocol Binding for
        /// CloudEvents](https://github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md).
        PubsubTopic(std::string::String),
    }
}

/// The request message for
/// [SubscriptionsService.CreateSubscription][google.apps.events.subscriptions.v1.SubscriptionsService.CreateSubscription].
///
/// [google.apps.events.subscriptions.v1.SubscriptionsService.CreateSubscription]: crate::client::SubscriptionsService::create_subscription
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct CreateSubscriptionRequest {
    /// Required. The subscription resource to create.
    pub subscription: std::option::Option<crate::model::Subscription>,

    /// Optional. If set to `true`, validates and previews the request, but doesn't
    /// create the subscription.
    pub validate_only: bool,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl CreateSubscriptionRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [subscription][crate::model::CreateSubscriptionRequest::subscription].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::CreateSubscriptionRequest;
    /// use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = CreateSubscriptionRequest::new().set_subscription(Subscription::default()/* use setters */);
    /// ```
    pub fn set_subscription<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<crate::model::Subscription>,
    {
        self.subscription = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [subscription][crate::model::CreateSubscriptionRequest::subscription].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::CreateSubscriptionRequest;
    /// use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = CreateSubscriptionRequest::new().set_or_clear_subscription(Some(Subscription::default()/* use setters */));
    /// let x = CreateSubscriptionRequest::new().set_or_clear_subscription(None::<Subscription>);
    /// ```
    pub fn set_or_clear_subscription<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<crate::model::Subscription>,
    {
        self.subscription = v.map(|x| x.into());
        self
    }

    /// Sets the value of [validate_only][crate::model::CreateSubscriptionRequest::validate_only].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::CreateSubscriptionRequest;
    /// let x = CreateSubscriptionRequest::new().set_validate_only(true);
    /// ```
    pub fn set_validate_only<T: std::convert::Into<bool>>(mut self, v: T) -> Self {
        self.validate_only = v.into();
        self
    }
}

impl wkt::message::Message for CreateSubscriptionRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.CreateSubscriptionRequest"
    }
}

/// The request message for
/// [SubscriptionsService.DeleteSubscription][google.apps.events.subscriptions.v1.SubscriptionsService.DeleteSubscription].
///
/// [google.apps.events.subscriptions.v1.SubscriptionsService.DeleteSubscription]: crate::client::SubscriptionsService::delete_subscription
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct DeleteSubscriptionRequest {
    /// Required. Resource name of the subscription to delete.
    ///
    /// Format: `subscriptions/{subscription}`
    pub name: std::string::String,

    /// Optional. If set to `true`, validates and previews the request, but doesn't
    /// delete the subscription.
    pub validate_only: bool,

    /// Optional. If set to `true` and the subscription isn't found, the request
    /// succeeds but doesn't delete the subscription.
    pub allow_missing: bool,

    /// Optional. Etag of the subscription.
    ///
    /// If present, it must match with the server's etag. Otherwise, request
    /// fails with the status `ABORTED`.
    pub etag: std::string::String,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl DeleteSubscriptionRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [name][crate::model::DeleteSubscriptionRequest::name].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::DeleteSubscriptionRequest;
    /// # let subscription_id = "subscription_id";
    /// let x = DeleteSubscriptionRequest::new().set_name(format!("subscriptions/{subscription_id}"));
    /// ```
    pub fn set_name<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.name = v.into();
        self
    }

    /// Sets the value of [validate_only][crate::model::DeleteSubscriptionRequest::validate_only].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::DeleteSubscriptionRequest;
    /// let x = DeleteSubscriptionRequest::new().set_validate_only(true);
    /// ```
    pub fn set_validate_only<T: std::convert::Into<bool>>(mut self, v: T) -> Self {
        self.validate_only = v.into();
        self
    }

    /// Sets the value of [allow_missing][crate::model::DeleteSubscriptionRequest::allow_missing].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::DeleteSubscriptionRequest;
    /// let x = DeleteSubscriptionRequest::new().set_allow_missing(true);
    /// ```
    pub fn set_allow_missing<T: std::convert::Into<bool>>(mut self, v: T) -> Self {
        self.allow_missing = v.into();
        self
    }

    /// Sets the value of [etag][crate::model::DeleteSubscriptionRequest::etag].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::DeleteSubscriptionRequest;
    /// let x = DeleteSubscriptionRequest::new().set_etag("example");
    /// ```
    pub fn set_etag<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.etag = v.into();
        self
    }
}

impl wkt::message::Message for DeleteSubscriptionRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.DeleteSubscriptionRequest"
    }
}

/// The request message for
/// [SubscriptionsService.GetSubscription][google.apps.events.subscriptions.v1.SubscriptionsService.GetSubscription].
///
/// [google.apps.events.subscriptions.v1.SubscriptionsService.GetSubscription]: crate::client::SubscriptionsService::get_subscription
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct GetSubscriptionRequest {
    /// Required. Resource name of the subscription.
    ///
    /// Format: `subscriptions/{subscription}`
    pub name: std::string::String,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl GetSubscriptionRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [name][crate::model::GetSubscriptionRequest::name].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::GetSubscriptionRequest;
    /// # let subscription_id = "subscription_id";
    /// let x = GetSubscriptionRequest::new().set_name(format!("subscriptions/{subscription_id}"));
    /// ```
    pub fn set_name<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.name = v.into();
        self
    }
}

impl wkt::message::Message for GetSubscriptionRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.GetSubscriptionRequest"
    }
}

/// The request message for
/// [SubscriptionsService.UpdateSubscription][google.apps.events.subscriptions.v1.SubscriptionsService.UpdateSubscription].
///
/// [google.apps.events.subscriptions.v1.SubscriptionsService.UpdateSubscription]: crate::client::SubscriptionsService::update_subscription
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct UpdateSubscriptionRequest {
    /// Required. The subscription to update.
    ///
    /// The subscription's `name` field is used to identify the subscription to
    /// update.
    pub subscription: std::option::Option<crate::model::Subscription>,

    /// Optional. Required. The field to update.
    ///
    /// You can update one of the following fields in a subscription:
    ///
    /// * [`expire_time`][google.apps.events.subscriptions.v1.Subscription.expire_time]: The timestamp when the
    ///   subscription expires.
    /// * [`ttl`][google.apps.events.subscriptions.v1.Subscription.ttl]: The
    ///   time-to-live (TTL) or duration of the
    ///   subscription.
    ///
    /// [google.apps.events.subscriptions.v1.Subscription.expire_time]: crate::model::Subscription::expiration
    /// [google.apps.events.subscriptions.v1.Subscription.ttl]: crate::model::Subscription::expiration
    pub update_mask: std::option::Option<wkt::FieldMask>,

    /// Optional. If set to `true`, validates and previews the request, but doesn't
    /// update the subscription.
    pub validate_only: bool,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl UpdateSubscriptionRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [subscription][crate::model::UpdateSubscriptionRequest::subscription].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::UpdateSubscriptionRequest;
    /// use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = UpdateSubscriptionRequest::new().set_subscription(Subscription::default()/* use setters */);
    /// ```
    pub fn set_subscription<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<crate::model::Subscription>,
    {
        self.subscription = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [subscription][crate::model::UpdateSubscriptionRequest::subscription].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::UpdateSubscriptionRequest;
    /// use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = UpdateSubscriptionRequest::new().set_or_clear_subscription(Some(Subscription::default()/* use setters */));
    /// let x = UpdateSubscriptionRequest::new().set_or_clear_subscription(None::<Subscription>);
    /// ```
    pub fn set_or_clear_subscription<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<crate::model::Subscription>,
    {
        self.subscription = v.map(|x| x.into());
        self
    }

    /// Sets the value of [update_mask][crate::model::UpdateSubscriptionRequest::update_mask].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::UpdateSubscriptionRequest;
    /// use wkt::FieldMask;
    /// let x = UpdateSubscriptionRequest::new().set_update_mask(FieldMask::default()/* use setters */);
    /// ```
    pub fn set_update_mask<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<wkt::FieldMask>,
    {
        self.update_mask = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [update_mask][crate::model::UpdateSubscriptionRequest::update_mask].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::UpdateSubscriptionRequest;
    /// use wkt::FieldMask;
    /// let x = UpdateSubscriptionRequest::new().set_or_clear_update_mask(Some(FieldMask::default()/* use setters */));
    /// let x = UpdateSubscriptionRequest::new().set_or_clear_update_mask(None::<FieldMask>);
    /// ```
    pub fn set_or_clear_update_mask<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<wkt::FieldMask>,
    {
        self.update_mask = v.map(|x| x.into());
        self
    }

    /// Sets the value of [validate_only][crate::model::UpdateSubscriptionRequest::validate_only].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::UpdateSubscriptionRequest;
    /// let x = UpdateSubscriptionRequest::new().set_validate_only(true);
    /// ```
    pub fn set_validate_only<T: std::convert::Into<bool>>(mut self, v: T) -> Self {
        self.validate_only = v.into();
        self
    }
}

impl wkt::message::Message for UpdateSubscriptionRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.UpdateSubscriptionRequest"
    }
}

/// The request message for
/// [SubscriptionsService.ReactivateSubscription][google.apps.events.subscriptions.v1.SubscriptionsService.ReactivateSubscription].
///
/// [google.apps.events.subscriptions.v1.SubscriptionsService.ReactivateSubscription]: crate::client::SubscriptionsService::reactivate_subscription
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct ReactivateSubscriptionRequest {
    /// Required. Resource name of the subscription.
    ///
    /// Format: `subscriptions/{subscription}`
    pub name: std::string::String,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl ReactivateSubscriptionRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [name][crate::model::ReactivateSubscriptionRequest::name].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::ReactivateSubscriptionRequest;
    /// # let subscription_id = "subscription_id";
    /// let x = ReactivateSubscriptionRequest::new().set_name(format!("subscriptions/{subscription_id}"));
    /// ```
    pub fn set_name<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.name = v.into();
        self
    }
}

impl wkt::message::Message for ReactivateSubscriptionRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.ReactivateSubscriptionRequest"
    }
}

/// The request message for
/// [SubscriptionsService.ListSubscriptions][google.apps.events.subscriptions.v1.SubscriptionsService.ListSubscriptions].
///
/// [google.apps.events.subscriptions.v1.SubscriptionsService.ListSubscriptions]: crate::client::SubscriptionsService::list_subscriptions
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct ListSubscriptionsRequest {
    /// Optional. The maximum number of subscriptions to return. The service might
    /// return fewer than this value.
    ///
    /// If unspecified or set to `0`, up to 50 subscriptions are returned.
    ///
    /// The maximum value is 100. If you specify a value more than 100, the system
    /// only returns 100 subscriptions.
    pub page_size: i32,

    /// Optional. A page token, received from a previous list subscriptions call.
    /// Provide this parameter to retrieve the subsequent page.
    ///
    /// When paginating, the filter value should match the call that provided the
    /// page token. Passing a different value might lead to unexpected results.
    pub page_token: std::string::String,

    /// Required. A query filter.
    ///
    /// You can filter subscriptions by event type (`event_types`)
    /// and target resource (`target_resource`).
    ///
    /// You must specify at least one event type in your query. To filter for
    /// multiple event types, use the `OR` operator.
    ///
    /// To filter by both event type and target resource, use the `AND` operator
    /// and specify the full resource name, such as
    /// `//chat.googleapis.com/spaces/{space}`.
    ///
    /// For example, the following queries are valid:
    ///
    /// ```norust
    /// event_types:"google.workspace.chat.membership.v1.updated" OR
    ///   event_types:"google.workspace.chat.message.v1.created"
    ///
    /// event_types:"google.workspace.chat.message.v1.created" AND
    ///   target_resource="//chat.googleapis.com/spaces/{space}"
    ///
    /// ( event_types:"google.workspace.chat.membership.v1.updated" OR
    ///   event_types:"google.workspace.chat.message.v1.created" ) AND
    ///   target_resource="//chat.googleapis.com/spaces/{space}"
    /// ```
    ///
    /// The server rejects invalid queries with an `INVALID_ARGUMENT`
    /// error.
    pub filter: std::string::String,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl ListSubscriptionsRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [page_size][crate::model::ListSubscriptionsRequest::page_size].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::ListSubscriptionsRequest;
    /// let x = ListSubscriptionsRequest::new().set_page_size(42);
    /// ```
    pub fn set_page_size<T: std::convert::Into<i32>>(mut self, v: T) -> Self {
        self.page_size = v.into();
        self
    }

    /// Sets the value of [page_token][crate::model::ListSubscriptionsRequest::page_token].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::ListSubscriptionsRequest;
    /// let x = ListSubscriptionsRequest::new().set_page_token("example");
    /// ```
    pub fn set_page_token<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.page_token = v.into();
        self
    }

    /// Sets the value of [filter][crate::model::ListSubscriptionsRequest::filter].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::ListSubscriptionsRequest;
    /// let x = ListSubscriptionsRequest::new().set_filter("example");
    /// ```
    pub fn set_filter<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.filter = v.into();
        self
    }
}

impl wkt::message::Message for ListSubscriptionsRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.ListSubscriptionsRequest"
    }
}

/// The response message for
/// [SubscriptionsService.ListSubscriptions][google.apps.events.subscriptions.v1.SubscriptionsService.ListSubscriptions].
///
/// [google.apps.events.subscriptions.v1.SubscriptionsService.ListSubscriptions]: crate::client::SubscriptionsService::list_subscriptions
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct ListSubscriptionsResponse {
    /// List of subscriptions.
    pub subscriptions: std::vec::Vec<crate::model::Subscription>,

    /// A token, which can be sent as `page_token` to retrieve the next page.
    /// If this field is omitted, there are no subsequent pages.
    pub next_page_token: std::string::String,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl ListSubscriptionsResponse {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [subscriptions][crate::model::ListSubscriptionsResponse::subscriptions].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::ListSubscriptionsResponse;
    /// use google_apps_events_subscriptions_v1::model::Subscription;
    /// let x = ListSubscriptionsResponse::new()
    ///     .set_subscriptions([
    ///         Subscription::default()/* use setters */,
    ///         Subscription::default()/* use (different) setters */,
    ///     ]);
    /// ```
    pub fn set_subscriptions<T, V>(mut self, v: T) -> Self
    where
        T: std::iter::IntoIterator<Item = V>,
        V: std::convert::Into<crate::model::Subscription>,
    {
        use std::iter::Iterator;
        self.subscriptions = v.into_iter().map(|i| i.into()).collect();
        self
    }

    /// Sets the value of [next_page_token][crate::model::ListSubscriptionsResponse::next_page_token].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_apps_events_subscriptions_v1::model::ListSubscriptionsResponse;
    /// let x = ListSubscriptionsResponse::new().set_next_page_token("example");
    /// ```
    pub fn set_next_page_token<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.next_page_token = v.into();
        self
    }
}

impl wkt::message::Message for ListSubscriptionsResponse {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.ListSubscriptionsResponse"
    }
}

#[doc(hidden)]
impl google_cloud_gax::paginator::internal::PageableResponse for ListSubscriptionsResponse {
    type PageItem = crate::model::Subscription;

    fn items(self) -> std::vec::Vec<Self::PageItem> {
        self.subscriptions
    }

    fn next_page_token(&self) -> std::string::String {
        use std::clone::Clone;
        self.next_page_token.clone()
    }
}

/// Metadata for UpdateSubscription LRO.
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct UpdateSubscriptionMetadata {
    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl UpdateSubscriptionMetadata {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }
}

impl wkt::message::Message for UpdateSubscriptionMetadata {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.UpdateSubscriptionMetadata"
    }
}

/// Metadata for CreateSubscription LRO.
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct CreateSubscriptionMetadata {
    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl CreateSubscriptionMetadata {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }
}

impl wkt::message::Message for CreateSubscriptionMetadata {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.CreateSubscriptionMetadata"
    }
}

/// Metadata for DeleteSubscription LRO.
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct DeleteSubscriptionMetadata {
    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl DeleteSubscriptionMetadata {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }
}

impl wkt::message::Message for DeleteSubscriptionMetadata {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.DeleteSubscriptionMetadata"
    }
}

/// Metadata for ReactivateSubscription LRO.
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct ReactivateSubscriptionMetadata {
    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl ReactivateSubscriptionMetadata {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }
}

impl wkt::message::Message for ReactivateSubscriptionMetadata {
    fn typename() -> &'static str {
        "type.googleapis.com/google.apps.events.subscriptions.v1.ReactivateSubscriptionMetadata"
    }
}