Struct OperationMetadata 

#[non_exhaustive]
pub struct OperationMetadata {
    pub create_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub target: String,
    pub verb: String,
    pub status_detail: String,
    pub cancel_requested: bool,
    pub api_version: String,
    pub request_resource: Option<Any>,
    pub stages: Vec<Stage>,
    pub source_token: String,
    pub build_name: String,
    pub operation_type: OperationType,
    /* private fields */
}

Represents the metadata of the long-running operation.

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.

create_time: Option<Timestamp>

The time the operation was created.

end_time: Option<Timestamp>

The time the operation finished running.

target: String

Server-defined resource path for the target of the operation.

verb: String

Name of the verb executed by the operation.

status_detail: String

Human-readable status of the operation, if any.

cancel_requested: bool

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

api_version: String

API version used to start the operation.

request_resource: Option<Any>

The original request that started the operation.

stages: Vec<Stage>

Mechanism for reporting in-progress stages

source_token: String

An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

build_name: String

The build name of the function for create and update operations.

operation_type: OperationType

The operation type.

Implementations

impl OperationMetadata

pub fn new() -> Self

Creates a new default instance.

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

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

where T: Into<Timestamp>,

Sets the value of end_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of end_time.

Example

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

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

Sets the value of target.

Example

let x = OperationMetadata::new().set_target("example");

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

Sets the value of verb.

Example

let x = OperationMetadata::new().set_verb("example");

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

Sets the value of status_detail.

Example

let x = OperationMetadata::new().set_status_detail("example");

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

Sets the value of cancel_requested.

Example

let x = OperationMetadata::new().set_cancel_requested(true);

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

Sets the value of api_version.

Example

let x = OperationMetadata::new().set_api_version("example");

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

where T: Into<Any>,

Sets the value of request_resource.

Example

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

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

where T: Into<Any>,

Sets or clears the value of request_resource.

Example

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

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

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

Sets the value of stages.

Example

use google_cloud_functions_v2::model::Stage;
let x = OperationMetadata::new()
    .set_stages([
        Stage::default()/* use setters */,
        Stage::default()/* use (different) setters */,
    ]);

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

Sets the value of source_token.

Example

let x = OperationMetadata::new().set_source_token("example");

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

Sets the value of build_name.

Example

let x = OperationMetadata::new().set_build_name("example");

pub fn set_operation_type<T: Into<OperationType>>(self, v: T) -> Self

Sets the value of operation_type.

Example

use google_cloud_functions_v2::model::OperationType;
let x0 = OperationMetadata::new().set_operation_type(OperationType::CreateFunction);
let x1 = OperationMetadata::new().set_operation_type(OperationType::UpdateFunction);
let x2 = OperationMetadata::new().set_operation_type(OperationType::DeleteFunction);

Trait Implementations

impl Clone for OperationMetadata

fn clone(&self) -> OperationMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OperationMetadata

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

Formats the value using the given formatter.

impl Default for OperationMetadata

fn default() -> OperationMetadata

Returns the “default value” for a type.

impl Message for OperationMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for OperationMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OperationMetadata