Struct Topic 

#[non_exhaustive]
pub struct Topic {
    pub name: String,
    pub labels: HashMap<String, String>,
    pub message_storage_policy: Option<MessageStoragePolicy>,
    pub kms_key_name: String,
    pub schema_settings: Option<SchemaSettings>,
    pub satisfies_pzs: bool,
    pub message_retention_duration: Option<Duration>,
    pub state: State,
    pub ingestion_data_source_settings: Option<IngestionDataSourceSettings>,
    pub message_transforms: Vec<MessageTransform>,
    pub tags: HashMap<String, String>,
    /* private fields */
}

A topic resource.

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

Required. Identifier. The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} 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".

labels: HashMap<String, String>

Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).

message_storage_policy: Option<MessageStoragePolicy>

Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.

kms_key_name: String

Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.

The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

schema_settings: Option<SchemaSettings>

Optional. Settings for validating messages published against a schema.

satisfies_pzs: bool

Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

message_retention_duration: Option<Duration>

Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.

state: State

Output only. An output-only field indicating the state of the topic.

ingestion_data_source_settings: Option<IngestionDataSourceSettings>

Optional. Settings for ingestion from a data source into this topic.

message_transforms: Vec<MessageTransform>

Optional. Transforms to be applied to messages published to the topic. 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

impl Topic

pub fn new() -> Self

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

Sets the value of name.

Example

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

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 = Topic::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

where T: Into<MessageStoragePolicy>,

Sets the value of message_storage_policy.

Example

use google_cloud_pubsub::model::MessageStoragePolicy;
let x = Topic::new().set_message_storage_policy(MessageStoragePolicy::default()/* use setters */);

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

where T: Into<MessageStoragePolicy>,

Sets or clears the value of message_storage_policy.

Example

use google_cloud_pubsub::model::MessageStoragePolicy;
let x = Topic::new().set_or_clear_message_storage_policy(Some(MessageStoragePolicy::default()/* use setters */));
let x = Topic::new().set_or_clear_message_storage_policy(None::<MessageStoragePolicy>);

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

Sets the value of kms_key_name.

Example

let x = Topic::new().set_kms_key_name("example");

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

where T: Into<SchemaSettings>,

Sets the value of schema_settings.

Example

use google_cloud_pubsub::model::SchemaSettings;
let x = Topic::new().set_schema_settings(SchemaSettings::default()/* use setters */);

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

where T: Into<SchemaSettings>,

Sets or clears the value of schema_settings.

Example

use google_cloud_pubsub::model::SchemaSettings;
let x = Topic::new().set_or_clear_schema_settings(Some(SchemaSettings::default()/* use setters */));
let x = Topic::new().set_or_clear_schema_settings(None::<SchemaSettings>);

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

Sets the value of satisfies_pzs.

Example

let x = Topic::new().set_satisfies_pzs(true);

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 = Topic::new().set_message_retention_duration(Duration::default()/* use setters */);

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 = Topic::new().set_or_clear_message_retention_duration(Some(Duration::default()/* use setters */));
let x = Topic::new().set_or_clear_message_retention_duration(None::<Duration>);

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

Sets the value of state.

Example

use google_cloud_pubsub::model::topic::State;
let x0 = Topic::new().set_state(State::Active);
let x1 = Topic::new().set_state(State::IngestionResourceError);

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

where T: Into<IngestionDataSourceSettings>,

Sets the value of ingestion_data_source_settings.

Example

use google_cloud_pubsub::model::IngestionDataSourceSettings;
let x = Topic::new().set_ingestion_data_source_settings(IngestionDataSourceSettings::default()/* use setters */);

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

where T: Into<IngestionDataSourceSettings>,

Sets or clears the value of ingestion_data_source_settings.

Example

use google_cloud_pubsub::model::IngestionDataSourceSettings;
let x = Topic::new().set_or_clear_ingestion_data_source_settings(Some(IngestionDataSourceSettings::default()/* use setters */));
let x = Topic::new().set_or_clear_ingestion_data_source_settings(None::<IngestionDataSourceSettings>);

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 = Topic::new()
    .set_message_transforms([
        MessageTransform::default()/* use setters */,
        MessageTransform::default()/* use (different) setters */,
    ]);

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 = Topic::new().set_tags([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

Trait Implementations

impl Clone for Topic

fn clone(&self) -> Topic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Topic

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

Formats the value using the given formatter.

impl Default for Topic

fn default() -> Topic

Returns the “default value” for a type.

impl Message for Topic

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Topic

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

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

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

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

impl StructuralPartialEq for Topic