Class GetSerialPortOutputInstanceRequest (1.23.0)

GetSerialPortOutputInstanceRequest(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
instance str
Name of the instance for this request.
port int
Specifies which COM or serial port to retrieve data from. This field is a member of oneof_ _port.
project str
Project ID for this request.
start int
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. This field is a member of oneof_ _start.
zone str
The name of the zone for this request.