Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::GetSerialPortOutputInstanceRequest (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::GetSerialPortOutputInstanceRequest.

A request message for Instances.GetSerialPortOutput. See the method description for details.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#instance

def instance() -> ::String
Returns
  • (::String) — Name of the instance for this request.

#instance=

def instance=(value) -> ::String
Parameter
  • value (::String) — Name of the instance for this request.
Returns
  • (::String) — Name of the instance for this request.

#port

def port() -> ::Integer
Returns
  • (::Integer) — Specifies which COM or serial port to retrieve data from.

#port=

def port=(value) -> ::Integer
Parameter
  • value (::Integer) — Specifies which COM or serial port to retrieve data from.
Returns
  • (::Integer) — Specifies which COM or serial port to retrieve data from.

#project

def project() -> ::String
Returns
  • (::String) — Project ID for this request.

#project=

def project=(value) -> ::String
Parameter
  • value (::String) — Project ID for this request.
Returns
  • (::String) — Project ID for this request.

#start

def start() -> ::Integer
Returns
  • (::Integer) — 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.

#start=

def start=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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

def zone() -> ::String
Returns
  • (::String) — The name of the zone for this request.

#zone=

def zone=(value) -> ::String
Parameter
  • value (::String) — The name of the zone for this request.
Returns
  • (::String) — The name of the zone for this request.