Struct UtilizationReport 

#[non_exhaustive]
pub struct UtilizationReport {
    pub name: String,
    pub display_name: String,
    pub state: State,
    pub state_time: Option<Timestamp>,
    pub error: Option<Status>,
    pub create_time: Option<Timestamp>,
    pub time_frame: TimeFrame,
    pub frame_end_time: Option<Timestamp>,
    pub vm_count: i32,
    pub vms: Vec<VmUtilizationInfo>,
    /* private fields */
}

Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.

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. The report unique name.

display_name: String

The report display name, as assigned by the user.

state: State

Output only. Current state of the report.

state_time: Option<Timestamp>

Output only. The time the state was last set.

error: Option<Status>

Output only. Provides details on the state of the report in case of an error.

create_time: Option<Timestamp>

Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).

time_frame: TimeFrame

Time frame of the report.

frame_end_time: Option<Timestamp>

Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the “frame_end_time” value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.

vm_count: i32

Output only. Total number of VMs included in the report.

vms: Vec<VmUtilizationInfo>

List of utilization information per VM. When sent as part of the request, the “vm_id” field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

Implementations

impl UtilizationReport

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 = UtilizationReport::new().set_name(format!("projects/{project_id}/locations/{location_id}/sources/{source_id}/utilizationReports/{utilization_report_id}"));

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

Sets the value of display_name.

Example

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

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

Sets the value of state.

Example

use google_cloud_vmmigration_v1::model::utilization_report::State;
let x0 = UtilizationReport::new().set_state(State::Creating);
let x1 = UtilizationReport::new().set_state(State::Succeeded);
let x2 = UtilizationReport::new().set_state(State::Failed);

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

where T: Into<Timestamp>,

Sets the value of state_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of state_time.

Example

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

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

where T: Into<Status>,

Sets the value of error.

Example

use google_cloud_rpc::model::Status;
let x = UtilizationReport::new().set_error(Status::default()/* use setters */);

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

where T: Into<Status>,

Sets or clears the value of error.

Example

use google_cloud_rpc::model::Status;
let x = UtilizationReport::new().set_or_clear_error(Some(Status::default()/* use setters */));
let x = UtilizationReport::new().set_or_clear_error(None::<Status>);

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

pub fn set_time_frame<T: Into<TimeFrame>>(self, v: T) -> Self

Sets the value of time_frame.

Example

use google_cloud_vmmigration_v1::model::utilization_report::TimeFrame;
let x0 = UtilizationReport::new().set_time_frame(TimeFrame::Week);
let x1 = UtilizationReport::new().set_time_frame(TimeFrame::Month);
let x2 = UtilizationReport::new().set_time_frame(TimeFrame::Year);

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

where T: Into<Timestamp>,

Sets the value of frame_end_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of frame_end_time.

Example

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

pub fn set_vm_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of vm_count.

Example

let x = UtilizationReport::new().set_vm_count(42);

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

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

Sets the value of vms.

Example

use google_cloud_vmmigration_v1::model::VmUtilizationInfo;
let x = UtilizationReport::new()
    .set_vms([
        VmUtilizationInfo::default()/* use setters */,
        VmUtilizationInfo::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for UtilizationReport

fn clone(&self) -> UtilizationReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UtilizationReport

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

Formats the value using the given formatter.

impl Default for UtilizationReport

fn default() -> UtilizationReport

Returns the “default value” for a type.

impl Message for UtilizationReport

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UtilizationReport

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