com.google.api.services.compute

Class Compute.Instances.GetSerialPortOutput

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.compute.ComputeRequest<SerialPortOutput>

com.google.api.services.compute.Compute.Instances.GetSerialPortOutput

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Instances

public class Compute.Instances.GetSerialPortOutput
extends ComputeRequest<SerialPortOutput>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetSerialPortOutput(String project, String zone, String instance) Returns the last 1 MB of serial port output from the specified instance.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getInstance() Name of the instance for this request.
Integer	getPort() Specifies which COM or serial port to retrieve data from.
String	getProject() Project ID for this request.
Long	getStart() Specifies the starting byte position of the output to return.
String	getZone() The name of the zone for this request.
Compute.Instances.GetSerialPortOutput	set(String parameterName, Object value)
Compute.Instances.GetSerialPortOutput	set$Xgafv(String $Xgafv) V1 error format.
Compute.Instances.GetSerialPortOutput	setAccessToken(String accessToken) OAuth access token.
Compute.Instances.GetSerialPortOutput	setAlt(String alt) Data format for response.
Compute.Instances.GetSerialPortOutput	setCallback(String callback) JSONP
Compute.Instances.GetSerialPortOutput	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.Instances.GetSerialPortOutput	setInstance(String instance) Name of the instance for this request.
Compute.Instances.GetSerialPortOutput	setKey(String key) API key.
Compute.Instances.GetSerialPortOutput	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.Instances.GetSerialPortOutput	setPort(Integer port) Specifies which COM or serial port to retrieve data from.
Compute.Instances.GetSerialPortOutput	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Instances.GetSerialPortOutput	setProject(String project) Project ID for this request.
Compute.Instances.GetSerialPortOutput	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Compute.Instances.GetSerialPortOutput	setStart(Long start) Specifies the starting byte position of the output to return.
Compute.Instances.GetSerialPortOutput	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Compute.Instances.GetSerialPortOutput	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Compute.Instances.GetSerialPortOutput	setUserIp(String userIp) Legacy name for parameter that has been superseded by `quotaUser`.
Compute.Instances.GetSerialPortOutput	setZone(String zone) The name of the zone for this request.

Methods inherited from class com.google.api.services.compute.ComputeRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GetSerialPortOutput

protected GetSerialPortOutput(String project,
                              String zone,
                              String instance)

Returns the last 1 MB of serial port output from the specified instance. Create a request for the method "instances.getSerialPortOutput". This request holds the parameters needed by the the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

GetSerialPortOutput#initialize(com.google.api.client.googleapis.services. AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance for this request.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<SerialPortOutput>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<SerialPortOutput>

Throws:

IOException

set$Xgafv

public Compute.Instances.GetSerialPortOutput set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<SerialPortOutput>

setAccessToken

public Compute.Instances.GetSerialPortOutput setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<SerialPortOutput>

setAlt

public Compute.Instances.GetSerialPortOutput setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<SerialPortOutput>

setCallback

public Compute.Instances.GetSerialPortOutput setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<SerialPortOutput>

setFields

public Compute.Instances.GetSerialPortOutput setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<SerialPortOutput>

setKey

public Compute.Instances.GetSerialPortOutput setKey(String key)

Description copied from class: ComputeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class ComputeRequest<SerialPortOutput>

setOauthToken

public Compute.Instances.GetSerialPortOutput setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<SerialPortOutput>

setPrettyPrint

public Compute.Instances.GetSerialPortOutput setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<SerialPortOutput>

setQuotaUser

public Compute.Instances.GetSerialPortOutput setQuotaUser(String quotaUser)

Description copied from class: ComputeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class ComputeRequest<SerialPortOutput>

setUploadType

public Compute.Instances.GetSerialPortOutput setUploadType(String uploadType)

Description copied from class: ComputeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ComputeRequest<SerialPortOutput>

setUploadProtocol

public Compute.Instances.GetSerialPortOutput setUploadProtocol(String uploadProtocol)

Description copied from class: ComputeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ComputeRequest<SerialPortOutput>

setUserIp

public Compute.Instances.GetSerialPortOutput setUserIp(String userIp)

Description copied from class: ComputeRequest

Legacy name for parameter that has been superseded by `quotaUser`.

Overrides:

setUserIp in class ComputeRequest<SerialPortOutput>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.Instances.GetSerialPortOutput setProject(String project)

Project ID for this request.

getZone

public String getZone()

The name of the zone for this request.

setZone

public Compute.Instances.GetSerialPortOutput setZone(String zone)

The name of the zone for this request.

getInstance

public String getInstance()

Name of the instance for this request.

setInstance

public Compute.Instances.GetSerialPortOutput setInstance(String instance)

Name of the instance for this request.

getPort

public Integer getPort()

Specifies which COM or serial port to retrieve data from. [default: 1] [minimum: 1] [maximum: 4]

setPort

public Compute.Instances.GetSerialPortOutput setPort(Integer port)

Specifies which COM or serial port to retrieve data from.

getStart

public Long 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.

setStart

public Compute.Instances.GetSerialPortOutput setStart(Long start)

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.

set

public Compute.Instances.GetSerialPortOutput set(String parameterName,
                                                 Object value)

Overrides:

set in class ComputeRequest<SerialPortOutput>