Struct Operation

#[non_exhaustive]
pub struct Operation {
    pub name: String,
    pub metadata: Option<Any>,
    pub done: bool,
    pub result: Option<Result>,
}

This resource represents a long-running operation that is the result of a network API call.

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

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

metadata: Option<Any>

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

done: bool

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

result: Option<Result>

The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response can be set. Some services might not provide the result.

Implementations

impl Operation

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

Sets the value of name.

pub fn set_metadata<T: Into<Option<Any>>>(self, v: T) -> Self

Sets the value of metadata.

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

Sets the value of done.

pub fn set_result<T: Into<Option<Result>>>(self, v: T) -> Self

Sets the value of result.

pub fn get_error(&self) -> Option<&Box<Status>>

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

pub fn get_response(&self) -> Option<&Box<Any>>

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

pub fn set_error<T: Into<Box<Status>>>(self, v: T) -> Self

Sets the value of result to hold a Error.

Note that all the setters affecting result are mutually exclusive.

pub fn set_response<T: Into<Box<Any>>>(self, v: T) -> Self

Sets the value of result to hold a Response.

Note that all the setters affecting result are mutually exclusive.

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Operation

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

Formats the value using the given formatter.

impl Default for Operation

fn default() -> Operation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Operation

where Operation: 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 Operation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Operation

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

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 Operation