Struct Subscription 

#[non_exhaustive]
pub struct Subscription {

    pub name: String,
    pub creation_time: Option<Timestamp>,
    pub last_modify_time: Option<Timestamp>,
    pub organization_id: String,
    pub organization_display_name: String,
    pub state: State,
    pub linked_dataset_map: HashMap<String, LinkedResource>,
    pub subscriber_contact: String,
    pub linked_resources: Vec<LinkedResource>,
    pub resource_type: SharedResourceType,
    pub commercial_info: Option<CommercialInfo>,
    pub log_linked_dataset_query_user_email: Option<bool>,
    pub destination_dataset: Option<DestinationDataset>,
    pub resource_name: Option<ResourceName>,
    /* private fields */
}

A subscription represents a subscribers’ access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.

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.

name: String

Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123.

creation_time: Option<Timestamp>

Output only. Timestamp when the subscription was created.

last_modify_time: Option<Timestamp>

Output only. Timestamp when the subscription was last modified.

organization_id: String

Output only. Organization of the project this subscription belongs to.

organization_display_name: String

Output only. Display name of the project of this subscription.

state: State

Output only. Current state of the subscription.

linked_dataset_map: HashMap<String, LinkedResource>

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

subscriber_contact: String

Output only. Email of the subscriber.

linked_resources: Vec<LinkedResource>

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

resource_type: SharedResourceType

Output only. Listing shared asset type.

commercial_info: Option<CommercialInfo>

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

log_linked_dataset_query_user_email: Option<bool>

Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.

destination_dataset: Option<DestinationDataset>

Optional. BigQuery destination dataset to create for the subscriber.

resource_name: Option<ResourceName>

Implementations

impl Subscription

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Subscription::new().set_name(format!("projects/{project_id}/locations/{location_id}/subscriptions/{subscription_id}"));

pub fn set_creation_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of creation_time.

Example

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

pub fn set_or_clear_creation_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of creation_time.

Example

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

pub fn set_last_modify_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of last_modify_time.

Example

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

pub fn set_or_clear_last_modify_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of last_modify_time.

Example

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

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

Sets the value of organization_id.

Example

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

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

Sets the value of organization_display_name.

Example

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

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

Sets the value of state.

Example

use google_cloud_bigquery_analyticshub_v1::model::subscription::State;
let x0 = Subscription::new().set_state(State::Active);
let x1 = Subscription::new().set_state(State::Stale);
let x2 = Subscription::new().set_state(State::Inactive);

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

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

Sets the value of linked_dataset_map.

Example

use google_cloud_bigquery_analyticshub_v1::model::subscription::LinkedResource;
let x = Subscription::new().set_linked_dataset_map([
    ("key0", LinkedResource::default()/* use setters */),
    ("key1", LinkedResource::default()/* use (different) setters */),
]);

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

Sets the value of subscriber_contact.

Example

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

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

where T: IntoIterator<Item = V>, V: Into<LinkedResource>,

Sets the value of linked_resources.

Example

use google_cloud_bigquery_analyticshub_v1::model::subscription::LinkedResource;
let x = Subscription::new()
    .set_linked_resources([
        LinkedResource::default()/* use setters */,
        LinkedResource::default()/* use (different) setters */,
    ]);

pub fn set_resource_type<T: Into<SharedResourceType>>(self, v: T) -> Self

Sets the value of resource_type.

Example

use google_cloud_bigquery_analyticshub_v1::model::SharedResourceType;
let x0 = Subscription::new().set_resource_type(SharedResourceType::BigqueryDataset);
let x1 = Subscription::new().set_resource_type(SharedResourceType::PubsubTopic);

pub fn set_commercial_info<T>(self, v: T) -> Self

where T: Into<CommercialInfo>,

Sets the value of commercial_info.

Example

use google_cloud_bigquery_analyticshub_v1::model::subscription::CommercialInfo;
let x = Subscription::new().set_commercial_info(CommercialInfo::default()/* use setters */);

pub fn set_or_clear_commercial_info<T>(self, v: Option<T>) -> Self

where T: Into<CommercialInfo>,

Sets or clears the value of commercial_info.

Example

use google_cloud_bigquery_analyticshub_v1::model::subscription::CommercialInfo;
let x = Subscription::new().set_or_clear_commercial_info(Some(CommercialInfo::default()/* use setters */));
let x = Subscription::new().set_or_clear_commercial_info(None::<CommercialInfo>);

pub fn set_log_linked_dataset_query_user_email<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of log_linked_dataset_query_user_email.

Example

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

pub fn set_or_clear_log_linked_dataset_query_user_email<T>( self, v: Option<T>, ) -> Self

where T: Into<bool>,

Sets or clears the value of log_linked_dataset_query_user_email.

Example

let x = Subscription::new().set_or_clear_log_linked_dataset_query_user_email(Some(false));
let x = Subscription::new().set_or_clear_log_linked_dataset_query_user_email(None::<bool>);

pub fn set_destination_dataset<T>(self, v: T) -> Self

where T: Into<DestinationDataset>,

Sets the value of destination_dataset.

Example

use google_cloud_bigquery_analyticshub_v1::model::DestinationDataset;
let x = Subscription::new().set_destination_dataset(DestinationDataset::default()/* use setters */);

pub fn set_or_clear_destination_dataset<T>(self, v: Option<T>) -> Self

where T: Into<DestinationDataset>,

Sets or clears the value of destination_dataset.

Example

use google_cloud_bigquery_analyticshub_v1::model::DestinationDataset;
let x = Subscription::new().set_or_clear_destination_dataset(Some(DestinationDataset::default()/* use setters */));
let x = Subscription::new().set_or_clear_destination_dataset(None::<DestinationDataset>);

pub fn set_resource_name<T: Into<Option<ResourceName>>>(self, v: T) -> Self

Sets the value of resource_name.

Note that all the setters affecting resource_name are mutually exclusive.

Example

use google_cloud_bigquery_analyticshub_v1::model::subscription::ResourceName;
let x = Subscription::new().set_resource_name(Some(ResourceName::Listing("example".to_string())));

pub fn listing(&self) -> Option<&String>

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

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

Sets the value of resource_name to hold a Listing.

Note that all the setters affecting resource_name are mutually exclusive.

Example

let x = Subscription::new().set_listing("example");
assert!(x.listing().is_some());
assert!(x.data_exchange().is_none());

pub fn data_exchange(&self) -> Option<&String>

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

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

Sets the value of resource_name to hold a DataExchange.

Note that all the setters affecting resource_name are mutually exclusive.

Example

let x = Subscription::new().set_data_exchange("example");
assert!(x.data_exchange().is_some());
assert!(x.listing().is_none());

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl Default for Subscription

fn default() -> Subscription

Returns the “default value” for a type.

impl Message for Subscription

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Subscription

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Subscription