Struct Stream 

#[non_exhaustive]
pub struct Stream {

    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub display_name: String,
    pub source_config: Option<SourceConfig>,
    pub destination_config: Option<DestinationConfig>,
    pub state: State,
    pub errors: Vec<Error>,
    pub customer_managed_encryption_key: Option<String>,
    pub last_recovery_time: Option<Timestamp>,
    pub satisfies_pzs: Option<bool>,
    pub satisfies_pzi: Option<bool>,
    pub backfill_strategy: Option<BackfillStrategy>,
    /* private fields */
}

A resource representing streaming data from a source to a destination.

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. Identifier. The stream’s name.

create_time: Option<Timestamp>

Output only. The creation time of the stream.

update_time: Option<Timestamp>

Output only. The last update time of the stream.

labels: HashMap<String, String>

Labels.

display_name: String

Required. Display name.

source_config: Option<SourceConfig>

Required. Source connection profile configuration.

destination_config: Option<DestinationConfig>

Required. Destination connection profile configuration.

state: State

The state of the stream.

errors: Vec<Error>

Output only. Errors on the Stream.

customer_managed_encryption_key: Option<String>

Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

last_recovery_time: Option<Timestamp>

Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.

satisfies_pzs: Option<bool>

Output only. Reserved for future use.

satisfies_pzi: Option<bool>

Output only. Reserved for future use.

backfill_strategy: Option<BackfillStrategy>

Stream backfill strategy.

Implementations

impl Stream

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 = Stream::new().set_name(format!("projects/{project_id}/locations/{location_id}/streams/{stream_id}"));

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

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

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

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

Sets the value of display_name.

Example

let x = Stream::new().set_display_name("example");

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

where T: Into<SourceConfig>,

Sets the value of source_config.

Example

use google_cloud_datastream_v1::model::SourceConfig;
let x = Stream::new().set_source_config(SourceConfig::default()/* use setters */);

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

where T: Into<SourceConfig>,

Sets or clears the value of source_config.

Example

use google_cloud_datastream_v1::model::SourceConfig;
let x = Stream::new().set_or_clear_source_config(Some(SourceConfig::default()/* use setters */));
let x = Stream::new().set_or_clear_source_config(None::<SourceConfig>);

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

where T: Into<DestinationConfig>,

Sets the value of destination_config.

Example

use google_cloud_datastream_v1::model::DestinationConfig;
let x = Stream::new().set_destination_config(DestinationConfig::default()/* use setters */);

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

where T: Into<DestinationConfig>,

Sets or clears the value of destination_config.

Example

use google_cloud_datastream_v1::model::DestinationConfig;
let x = Stream::new().set_or_clear_destination_config(Some(DestinationConfig::default()/* use setters */));
let x = Stream::new().set_or_clear_destination_config(None::<DestinationConfig>);

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

Sets the value of state.

Example

use google_cloud_datastream_v1::model::stream::State;
let x0 = Stream::new().set_state(State::NotStarted);
let x1 = Stream::new().set_state(State::Running);
let x2 = Stream::new().set_state(State::Paused);

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

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

Sets the value of errors.

Example

use google_cloud_datastream_v1::model::Error;
let x = Stream::new()
    .set_errors([
        Error::default()/* use setters */,
        Error::default()/* use (different) setters */,
    ]);

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

where T: Into<String>,

Sets the value of customer_managed_encryption_key.

Example

let x = Stream::new().set_customer_managed_encryption_key("example");

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

where T: Into<String>,

Sets or clears the value of customer_managed_encryption_key.

Example

let x = Stream::new().set_or_clear_customer_managed_encryption_key(Some("example"));
let x = Stream::new().set_or_clear_customer_managed_encryption_key(None::<String>);

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

where T: Into<Timestamp>,

Sets the value of last_recovery_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of last_recovery_time.

Example

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

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

where T: Into<bool>,

Sets the value of satisfies_pzs.

Example

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

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

where T: Into<bool>,

Sets or clears the value of satisfies_pzs.

Example

let x = Stream::new().set_or_clear_satisfies_pzs(Some(false));
let x = Stream::new().set_or_clear_satisfies_pzs(None::<bool>);

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

where T: Into<bool>,

Sets the value of satisfies_pzi.

Example

let x = Stream::new().set_satisfies_pzi(true);

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

where T: Into<bool>,

Sets or clears the value of satisfies_pzi.

Example

let x = Stream::new().set_or_clear_satisfies_pzi(Some(false));
let x = Stream::new().set_or_clear_satisfies_pzi(None::<bool>);

pub fn set_backfill_strategy<T: Into<Option<BackfillStrategy>>>( self, v: T, ) -> Self

Sets the value of backfill_strategy.

Note that all the setters affecting backfill_strategy are mutually exclusive.

Example

use google_cloud_datastream_v1::model::stream::BackfillAllStrategy;
let x = Stream::new().set_backfill_strategy(Some(
    google_cloud_datastream_v1::model::stream::BackfillStrategy::BackfillAll(BackfillAllStrategy::default().into())));

pub fn backfill_all(&self) -> Option<&Box<BackfillAllStrategy>>

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

pub fn set_backfill_all<T: Into<Box<BackfillAllStrategy>>>(self, v: T) -> Self

Sets the value of backfill_strategy to hold a BackfillAll.

Note that all the setters affecting backfill_strategy are mutually exclusive.

Example

use google_cloud_datastream_v1::model::stream::BackfillAllStrategy;
let x = Stream::new().set_backfill_all(BackfillAllStrategy::default()/* use setters */);
assert!(x.backfill_all().is_some());
assert!(x.backfill_none().is_none());

pub fn backfill_none(&self) -> Option<&Box<BackfillNoneStrategy>>

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

pub fn set_backfill_none<T: Into<Box<BackfillNoneStrategy>>>(self, v: T) -> Self

Sets the value of backfill_strategy to hold a BackfillNone.

Note that all the setters affecting backfill_strategy are mutually exclusive.

Example

use google_cloud_datastream_v1::model::stream::BackfillNoneStrategy;
let x = Stream::new().set_backfill_none(BackfillNoneStrategy::default()/* use setters */);
assert!(x.backfill_none().is_some());
assert!(x.backfill_all().is_none());

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl Default for Stream

fn default() -> Stream

Returns the “default value” for a type.

impl Message for Stream

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Stream

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Stream