Struct CreateStreamRequest

#[non_exhaustive]
pub struct CreateStreamRequest {
    pub parent: String,
    pub stream_id: String,
    pub stream: Option<Stream>,
    pub request_id: String,
    pub validate_only: bool,
    pub force: bool,
    /* private fields */
}

Request message for creating a stream.

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.

parent: String

Required. The parent that owns the collection of streams.

stream_id: String

Required. The stream identifier.

stream: Option<Stream>

Required. The stream resource to create.

request_id: String

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

validate_only: bool

Optional. Only validate the stream, but don’t create any resources. The default is false.

force: bool

Optional. Create the stream without validating it.

Implementations

impl CreateStreamRequest

pub fn new() -> Self

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

Sets the value of parent.

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

Sets the value of stream_id.

pub fn set_stream<T: Into<Option<Stream>>>(self, v: T) -> Self

Sets the value of stream.

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

Sets the value of request_id.

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

Sets the value of validate_only.

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

Sets the value of force.

Trait Implementations

impl Clone for CreateStreamRequest

fn clone(&self) -> CreateStreamRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateStreamRequest

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

Formats the value using the given formatter.

impl Default for CreateStreamRequest

fn default() -> CreateStreamRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateStreamRequest

where CreateStreamRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for CreateStreamRequest

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for CreateStreamRequest

fn eq(&self, other: &CreateStreamRequest) -> 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 Serialize for CreateStreamRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateStreamRequest