Compute V1 Client - Class GetSerialPortOutputInstanceRequest (1.22.0)

Version latest

• 1.22.0 (latest)
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

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.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getZone

The name of the zone for this request.

Returns
Type	Description
string

setZone

The name of the zone for this request.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
project	string Project ID for this request.
zone	string The name of the zone for this request.
instance	string Name of the instance for this request.

Returns
Type	Description
GetSerialPortOutputInstanceRequest