Struct Operation 

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

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 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 = Operation::new().set_name("example");

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

where T: Into<Any>,

Sets the value of metadata.

Example

use wkt::Any;
let x = Operation::new().set_metadata(Any::default()/* use setters */);

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

where T: Into<Any>,

Sets or clears the value of metadata.

Example

use wkt::Any;
let x = Operation::new().set_or_clear_metadata(Some(Any::default()/* use setters */));
let x = Operation::new().set_or_clear_metadata(None::<Any>);

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

Sets the value of done.

Example

let x = Operation::new().set_done(true);

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

Sets the value of result.

Note that all the setters affecting result are mutually exclusive.

Example

use google_cloud_rpc::model::Status;
let x = Operation::new().set_result(Some(
    google_cloud_longrunning::model::operation::Result::Error(Status::default().into())));

pub fn 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 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.

Example

use google_cloud_rpc::model::Status;
let x = Operation::new().set_error(Status::default()/* use setters */);
assert!(x.error().is_some());
assert!(x.response().is_none());

pub fn 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_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.

Example

use wkt::Any;
let x = Operation::new().set_response(Any::default()/* use setters */);
assert!(x.response().is_some());
assert!(x.error().is_none());

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a duplicate 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 Message for Operation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Operation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Operation