Reference documentation and code samples for the Compute V1 Client class GetSerialPortOutputInstanceRequest.
A request message for Instances.GetSerialPortOutput. See the method description for details.
Generated from protobuf message google.cloud.compute.v1.GetSerialPortOutputInstanceRequest
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ instance
string
Name of the instance for this request.
↳ port
int
Specifies which COM or serial port to retrieve data from.
↳ project
string
Project ID for this request.
↳ start
int|string
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.
getInstance
Name of the instance for this request.
Returns
Type
Description
string
setInstance
Name of the instance for this request.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPort
Specifies which COM or serial port to retrieve data from.
Returns
Type
Description
int
hasPort
clearPort
setPort
Specifies which COM or serial port to retrieve data from.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getProject
Project ID for this request.
Returns
Type
Description
string
setProject
Project ID for this request.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getStart
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
Type
Description
int|string
hasStart
clearStart
setStart
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class GetSerialPortOutputInstanceRequest (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.GetSerialPortOutputInstanceRequest)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.GetSerialPortOutputInstanceRequest)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.GetSerialPortOutputInstanceRequest)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.GetSerialPortOutputInstanceRequest)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.GetSerialPortOutputInstanceRequest)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.GetSerialPortOutputInstanceRequest)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.GetSerialPortOutputInstanceRequest)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.GetSerialPortOutputInstanceRequest)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.GetSerialPortOutputInstanceRequest)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.GetSerialPortOutputInstanceRequest)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.GetSerialPortOutputInstanceRequest)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.GetSerialPortOutputInstanceRequest)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.GetSerialPortOutputInstanceRequest) \nReference documentation and code samples for the Compute V1 Client class GetSerialPortOutputInstanceRequest.\n\nA request message for Instances.GetSerialPortOutput. See the method description for details.\n\nGenerated from protobuf message `google.cloud.compute.v1.GetSerialPortOutputInstanceRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getInstance\n\nName of the instance for this request.\n\n### setInstance\n\nName of the instance for this request.\n\n### getPort\n\nSpecifies which COM or serial port to retrieve data from.\n\n### hasPort\n\n### clearPort\n\n### setPort\n\nSpecifies which COM or serial port to retrieve data from.\n\n### getProject\n\nProject ID for this request.\n\n### setProject\n\nProject ID for this request.\n\n### getStart\n\nSpecifies 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.\n\n### hasStart\n\n### clearStart\n\n### setStart\n\nSpecifies 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.\n\n### getZone\n\nThe name of the zone for this request.\n\n### setZone\n\nThe name of the zone for this request.\n\n### static::build"]]