Struct google_compute1::api::InstanceGetSerialPortOutputCall[−][src]

pub struct InstanceGetSerialPortOutputCall<'a, C> where
    C: 'a,  { /* fields omitted */ }

Returns the last 1 MB of serial port output from the specified instance.

A builder for the getSerialPortOutput method supported by a instance resource. It is not used directly, but through a InstanceMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.instances().get_serial_port_output("project", "zone", "instance")
             .start("kasd")
             .port(-12)
             .doit().await;

Implementations

impl<'a, C> InstanceGetSerialPortOutputCall<'a, C> where
    C: BorrowMut<Client<HttpsConnector<HttpConnector>, Body>>, [src]

pub async fn doit(self) -> Result<(Response<Body>, SerialPortOutput)>[src]

Perform the operation you have build so far.

pub fn project(self, new_value: &str) -> InstanceGetSerialPortOutputCall<'a, C>[src]

Project ID for this request.

Sets the project path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn zone(self, new_value: &str) -> InstanceGetSerialPortOutputCall<'a, C>[src]

The name of the zone for this request.

Sets the zone path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn instance(self, new_value: &str) -> InstanceGetSerialPortOutputCall<'a, C>[src]

Name of the instance for this request.

Sets the instance path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn start(self, new_value: &str) -> InstanceGetSerialPortOutputCall<'a, C>[src]

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.

Sets the start query property to the given value.

pub fn port(self, new_value: i32) -> InstanceGetSerialPortOutputCall<'a, C>[src]

Specifies which COM or serial port to retrieve data from.

Sets the port query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> InstanceGetSerialPortOutputCall<'a, C>[src]

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(
    self,
    name: T,
    value: T
) -> InstanceGetSerialPortOutputCall<'a, C> where
    T: AsRef<str>, [src]

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

  • alt (query-string) - Data format for the response.
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token (query-string) - OAuth 2.0 token for the current user.
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
  • userIp (query-string) - Deprecated. Please use quotaUser instead.

pub fn add_scope<T, S>(self, scope: T) -> InstanceGetSerialPortOutputCall<'a, C> where
    T: Into<Option<S>>,
    S: AsRef<str>, [src]

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::Readonly.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C> CallBuilder for InstanceGetSerialPortOutputCall<'a, C>[src]

Auto Trait Implementations

impl<'a, C> !RefUnwindSafe for InstanceGetSerialPortOutputCall<'a, C>[src]

impl<'a, C> !Send for InstanceGetSerialPortOutputCall<'a, C>[src]

impl<'a, C> !Sync for InstanceGetSerialPortOutputCall<'a, C>[src]

impl<'a, C> Unpin for InstanceGetSerialPortOutputCall<'a, C>[src]

impl<'a, C> !UnwindSafe for InstanceGetSerialPortOutputCall<'a, C>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.