Struct GetSerialPortOutputRequest 

#[non_exhaustive]
pub struct GetSerialPortOutputRequest {
    pub instance: String,
    pub port: Option<i32>,
    pub project: String,
    pub start: Option<i64>,
    pub zone: String,
    /* private fields */
}

Available on crate feature instances only.

Synthetic request message for the getSerialPortOutput() method.

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.

instance: String

Name of the instance for this request.

port: Option<i32>

Specifies which COM or serial port to retrieve data from.

project: String

Project ID for this request.

start: Option<i64>

Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to 0.

If the output for that byte position is available, this field matches the start parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the start property value.

You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console. Note that the negative start is bounded by the retained buffer size, and the returned serial console output will not exceed the max buffer size.

zone: String

The name of the zone for this request.

Implementations

impl GetSerialPortOutputRequest

pub fn new() -> Self

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

Sets the value of instance.

Example

let x = GetSerialPortOutputRequest::new().set_instance("example");

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

where T: Into<i32>,

Sets the value of port.

Example

let x = GetSerialPortOutputRequest::new().set_port(42);

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

where T: Into<i32>,

Sets or clears the value of port.

Example

let x = GetSerialPortOutputRequest::new().set_or_clear_port(Some(42));
let x = GetSerialPortOutputRequest::new().set_or_clear_port(None::<i32>);

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

Sets the value of project.

Example

let x = GetSerialPortOutputRequest::new().set_project("example");

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

where T: Into<i64>,

Sets the value of start.

Example

let x = GetSerialPortOutputRequest::new().set_start(42);

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

where T: Into<i64>,

Sets or clears the value of start.

Example

let x = GetSerialPortOutputRequest::new().set_or_clear_start(Some(42));
let x = GetSerialPortOutputRequest::new().set_or_clear_start(None::<i32>);

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

Sets the value of zone.

Example

let x = GetSerialPortOutputRequest::new().set_zone("example");

Trait Implementations

impl Clone for GetSerialPortOutputRequest

fn clone(&self) -> GetSerialPortOutputRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetSerialPortOutputRequest

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

Formats the value using the given formatter.

impl Default for GetSerialPortOutputRequest

fn default() -> GetSerialPortOutputRequest

Returns the “default value” for a type.

impl PartialEq for GetSerialPortOutputRequest

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