Compute V1 Client - Class SerialPortOutput (1.21.0)

Reference documentation and code samples for the Compute V1 Client class SerialPortOutput.

An instance serial console output.

Generated from protobuf message google.cloud.compute.v1.SerialPortOutput

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ contents string

[Output Only] The contents of the console output.

↳ kind string

[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

↳ next int|string

[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the contents property. Use this value in the next request as the start parameter.

↳ self_link string

[Output Only] Server-defined URL for this resource.

↳ start int|string

The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the start value that was specified in the request.

getContents

[Output Only] The contents of the console output.

Returns
Type Description
string

hasContents

clearContents

setContents

[Output Only] The contents of the console output.

Parameter
Name Description
var string
Returns
Type Description
$this

getKind

[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

Returns
Type Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

Parameter
Name Description
var string
Returns
Type Description
$this

getNext

[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the contents property. Use this value in the next request as the start parameter.

Returns
Type Description
int|string

hasNext

clearNext

setNext

[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the contents property. Use this value in the next request as the start parameter.

Parameter
Name Description
var int|string
Returns
Type Description
$this

[Output Only] Server-defined URL for this resource.

Returns
Type Description
string

[Output Only] Server-defined URL for this resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getStart

The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the start value that was specified in the request.

Returns
Type Description
int|string

hasStart

clearStart

setStart

The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the start value that was specified in the request.

Parameter
Name Description
var int|string
Returns
Type Description
$this