com.google.api.services.compute.model

Class Operation

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.Operation

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Operation
extends com.google.api.client.json.GenericJson

An Operation resource, used to manage asynchronous API requests.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Operation.Error [Output Only] If errors are generated during processing of the operation, this field will be populated.
static class	Operation.Warnings Model definition for OperationWarnings.

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

com.google.api.client.util.GenericData.Flags

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Operation()

Method Summary

Methods

Modifier and Type	Method and Description
Operation	clone()
java.lang.String	getClientOperationId() [Output Only] Reserved for future use.
java.lang.String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
java.lang.String	getDescription() [Output Only] A textual description of the operation, which is set when the operation is created.
java.lang.String	getEndTime() [Output Only] The time that this operation was completed.
Operation.Error	getError() [Output Only] If errors are generated during processing of the operation, this field will be populated.
java.lang.String	getHttpErrorMessage() [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
java.lang.Integer	getHttpErrorStatusCode() [Output Only] If the operation fails, this field contains the HTTP error status code that was returned.
java.math.BigInteger	getId() [Output Only] The unique identifier for the resource.
java.lang.String	getInsertTime() [Output Only] The time that this operation was requested.
java.lang.String	getKind() [Output Only] Type of the resource.
java.lang.String	getName() [Output Only] Name of the resource.
java.lang.String	getOperationType() [Output Only] The type of operation, such as insert, update, or delete, and so on.
java.lang.Integer	getProgress() [Output Only] An optional progress indicator that ranges from 0 to 100.
java.lang.String	getRegion() [Output Only] The URL of the region where the operation resides.
java.lang.String	getSelfLink() [Output Only] Server-defined URL for the resource.
java.lang.String	getStartTime() [Output Only] The time that this operation was started by the server.
java.lang.String	getStatus() [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
java.lang.String	getStatusMessage() [Output Only] An optional textual description of the current status of the operation.
java.math.BigInteger	getTargetId() [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
java.lang.String	getTargetLink() [Output Only] The URL of the resource that the operation modifies.
java.lang.String	getUser() [Output Only] User who requested the operation, for example: user@example.com.
java.util.List<Operation.Warnings>	getWarnings() [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
java.lang.String	getZone() [Output Only] The URL of the zone where the operation resides.
Operation	set(java.lang.String fieldName, java.lang.Object value)
Operation	setClientOperationId(java.lang.String clientOperationId) [Output Only] Reserved for future use.
Operation	setCreationTimestamp(java.lang.String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
Operation	setDescription(java.lang.String description) [Output Only] A textual description of the operation, which is set when the operation is created.
Operation	setEndTime(java.lang.String endTime) [Output Only] The time that this operation was completed.
Operation	setError(Operation.Error error) [Output Only] If errors are generated during processing of the operation, this field will be populated.
Operation	setHttpErrorMessage(java.lang.String httpErrorMessage) [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Operation	setHttpErrorStatusCode(java.lang.Integer httpErrorStatusCode) [Output Only] If the operation fails, this field contains the HTTP error status code that was returned.
Operation	setId(java.math.BigInteger id) [Output Only] The unique identifier for the resource.
Operation	setInsertTime(java.lang.String insertTime) [Output Only] The time that this operation was requested.
Operation	setKind(java.lang.String kind) [Output Only] Type of the resource.
Operation	setName(java.lang.String name) [Output Only] Name of the resource.
Operation	setOperationType(java.lang.String operationType) [Output Only] The type of operation, such as insert, update, or delete, and so on.
Operation	setProgress(java.lang.Integer progress) [Output Only] An optional progress indicator that ranges from 0 to 100.
Operation	setRegion(java.lang.String region) [Output Only] The URL of the region where the operation resides.
Operation	setSelfLink(java.lang.String selfLink) [Output Only] Server-defined URL for the resource.
Operation	setStartTime(java.lang.String startTime) [Output Only] The time that this operation was started by the server.
Operation	setStatus(java.lang.String status) [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
Operation	setStatusMessage(java.lang.String statusMessage) [Output Only] An optional textual description of the current status of the operation.
Operation	setTargetId(java.math.BigInteger targetId) [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Operation	setTargetLink(java.lang.String targetLink) [Output Only] The URL of the resource that the operation modifies.
Operation	setUser(java.lang.String user) [Output Only] User who requested the operation, for example: user@example.com.
Operation	setWarnings(java.util.List<Operation.Warnings> warnings) [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Operation	setZone(java.lang.String zone) [Output Only] The URL of the zone where the operation resides.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Operation

public Operation()

Method Detail

getClientOperationId

public java.lang.String getClientOperationId()

[Output Only] Reserved for future use.

Returns:

value or null for none

setClientOperationId

public Operation setClientOperationId(java.lang.String clientOperationId)

[Output Only] Reserved for future use.

Parameters:

clientOperationId - clientOperationId or null for none

getCreationTimestamp

public java.lang.String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public Operation setCreationTimestamp(java.lang.String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp or null for none

getDescription

public java.lang.String getDescription()

[Output Only] A textual description of the operation, which is set when the operation is created.

Returns:

value or null for none

setDescription

public Operation setDescription(java.lang.String description)

[Output Only] A textual description of the operation, which is set when the operation is created.

Parameters:

description - description or null for none

getEndTime

public java.lang.String getEndTime()

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Returns:

value or null for none

setEndTime

public Operation setEndTime(java.lang.String endTime)

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Parameters:

endTime - endTime or null for none

getError

public Operation.Error getError()

[Output Only] If errors are generated during processing of the operation, this field will be populated.

Returns:

value or null for none

setError

public Operation setError(Operation.Error error)

[Output Only] If errors are generated during processing of the operation, this field will be populated.

Parameters:

error - error or null for none

getHttpErrorMessage

public java.lang.String getHttpErrorMessage()

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

Returns:

value or null for none

setHttpErrorMessage

public Operation setHttpErrorMessage(java.lang.String httpErrorMessage)

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

Parameters:

httpErrorMessage - httpErrorMessage or null for none

getHttpErrorStatusCode

public java.lang.Integer getHttpErrorStatusCode()

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

Returns:

value or null for none

setHttpErrorStatusCode

public Operation setHttpErrorStatusCode(java.lang.Integer httpErrorStatusCode)

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

Parameters:

httpErrorStatusCode - httpErrorStatusCode or null for none

getId

public java.math.BigInteger getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:

value or null for none

setId

public Operation setId(java.math.BigInteger id)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters:

id - id or null for none

getInsertTime

public java.lang.String getInsertTime()

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Returns:

value or null for none

setInsertTime

public Operation setInsertTime(java.lang.String insertTime)

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Parameters:

insertTime - insertTime or null for none

getKind

public java.lang.String getKind()

[Output Only] Type of the resource. Always compute#operation for Operation resources.

Returns:

value or null for none

setKind

public Operation setKind(java.lang.String kind)

[Output Only] Type of the resource. Always compute#operation for Operation resources.

Parameters:

kind - kind or null for none

getName

public java.lang.String getName()

[Output Only] Name of the resource.

Returns:

value or null for none

setName

public Operation setName(java.lang.String name)

[Output Only] Name of the resource.

Parameters:

name - name or null for none

getOperationType

public java.lang.String getOperationType()

[Output Only] The type of operation, such as insert, update, or delete, and so on.

Returns:

value or null for none

setOperationType

public Operation setOperationType(java.lang.String operationType)

[Output Only] The type of operation, such as insert, update, or delete, and so on.

Parameters:

operationType - operationType or null for none

getProgress

public java.lang.Integer getProgress()

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

Returns:

value or null for none

setProgress

public Operation setProgress(java.lang.Integer progress)

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

Parameters:

progress - progress or null for none

getRegion

public java.lang.String getRegion()

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations.

Returns:

value or null for none

setRegion

public Operation setRegion(java.lang.String region)

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations.

Parameters:

region - region or null for none

getSelfLink

public java.lang.String getSelfLink()

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

Returns:

value or null for none

setSelfLink

public Operation setSelfLink(java.lang.String selfLink)

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

Parameters:

selfLink - selfLink or null for none

getStartTime

public java.lang.String getStartTime()

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Returns:

value or null for none

setStartTime

public Operation setStartTime(java.lang.String startTime)

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Parameters:

startTime - startTime or null for none

getStatus

public java.lang.String getStatus()

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

Returns:

value or null for none

setStatus

public Operation setStatus(java.lang.String status)

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

Parameters:

status - status or null for none

getStatusMessage

public java.lang.String getStatusMessage()

[Output Only] An optional textual description of the current status of the operation.

Returns:

value or null for none

setStatusMessage

public Operation setStatusMessage(java.lang.String statusMessage)

[Output Only] An optional textual description of the current status of the operation.

Parameters:

statusMessage - statusMessage or null for none

getTargetId

public java.math.BigInteger getTargetId()

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

Returns:

value or null for none

setTargetId

public Operation setTargetId(java.math.BigInteger targetId)

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

Parameters:

targetId - targetId or null for none

getTargetLink

public java.lang.String getTargetLink()

[Output Only] The URL of the resource that the operation modifies.

Returns:

value or null for none

setTargetLink

public Operation setTargetLink(java.lang.String targetLink)

[Output Only] The URL of the resource that the operation modifies.

Parameters:

targetLink - targetLink or null for none

getUser

public java.lang.String getUser()

[Output Only] User who requested the operation, for example: user@example.com.

Returns:

value or null for none

setUser

public Operation setUser(java.lang.String user)

[Output Only] User who requested the operation, for example: user@example.com.

Parameters:

user - user or null for none

getWarnings

public java.util.List<Operation.Warnings> getWarnings()

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

Returns:

value or null for none

setWarnings

public Operation setWarnings(java.util.List<Operation.Warnings> warnings)

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

Parameters:

warnings - warnings or null for none

getZone

public java.lang.String getZone()

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.

Returns:

value or null for none

setZone

public Operation setZone(java.lang.String zone)

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.

Parameters:

zone - zone or null for none

set

public Operation set(java.lang.String fieldName,
            java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Operation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson