Struct Profile 

#[non_exhaustive]
pub struct Profile {
    pub name: String,
    pub profile_type: ProfileType,
    pub deployment: Option<Deployment>,
    pub duration: Option<Duration>,
    pub profile_bytes: Bytes,
    pub labels: HashMap<String, String>,
    pub start_time: Option<Timestamp>,
    /* private fields */
}

Profile resource.

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. Opaque, server-assigned, unique ID for this profile.

profile_type: ProfileType

Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server.

deployment: Option<Deployment>

Deployment this profile corresponds to.

duration: Option<Duration>

Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can’t be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).

profile_bytes: Bytes

Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.

labels: HashMap<String, String>

Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.

start_time: Option<Timestamp>

Output only. Start time for the profile. This output is only present in response from the ListProfiles method.

Implementations

impl Profile

pub fn new() -> Self

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

Sets the value of name.

Example

let x = Profile::new().set_name("example");

pub fn set_profile_type<T: Into<ProfileType>>(self, v: T) -> Self

Sets the value of profile_type.

Example

use google_cloud_profiler_v2::model::ProfileType;
let x0 = Profile::new().set_profile_type(ProfileType::Cpu);
let x1 = Profile::new().set_profile_type(ProfileType::Wall);
let x2 = Profile::new().set_profile_type(ProfileType::Heap);

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

where T: Into<Deployment>,

Sets the value of deployment.

Example

use google_cloud_profiler_v2::model::Deployment;
let x = Profile::new().set_deployment(Deployment::default()/* use setters */);

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

where T: Into<Deployment>,

Sets or clears the value of deployment.

Example

use google_cloud_profiler_v2::model::Deployment;
let x = Profile::new().set_or_clear_deployment(Some(Deployment::default()/* use setters */));
let x = Profile::new().set_or_clear_deployment(None::<Deployment>);

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

where T: Into<Duration>,

Sets the value of duration.

Example

use wkt::Duration;
let x = Profile::new().set_duration(Duration::default()/* use setters */);

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

where T: Into<Duration>,

Sets or clears the value of duration.

Example

use wkt::Duration;
let x = Profile::new().set_or_clear_duration(Some(Duration::default()/* use setters */));
let x = Profile::new().set_or_clear_duration(None::<Duration>);

pub fn set_profile_bytes<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of profile_bytes.

Example

let x = Profile::new().set_profile_bytes(bytes::Bytes::from_static(b"example"));

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

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = Profile::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

where T: Into<Timestamp>,

Sets the value of start_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

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

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl Default for Profile

fn default() -> Profile

Returns the “default value” for a type.

impl Message for Profile

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Profile

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