Operation (GCloud Java compute 0.2.2 API)

java.lang.Object
- com.google.cloud.compute.Operation

All Implemented Interfaces:

Serializable
```
public class Operation
extends Object
implements Serializable
```
Google Compute Engine operations. Operation identity can be obtained via operationId(). operationId() returns GlobalOperationId for global operations, RegionOperationId for region operations, and ZoneOperationId for zone operations. To get an Operation object with the most recent information, use #reload(OperationOption...).

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Operation.OperationError` An error that can occur during the processing of a Google Compute Engine operation.
`static class`	`Operation.OperationWarning` A warning message that is generated during the processing of a Google Compute Engine operation.
`static class`	`Operation.Status` Status of an operation.

Method Summary

Methods
Modifier and Type	Method and Description
`Compute`	`compute()` Returns the operation's `Compute` object used to issue requests.
`boolean`	`delete()` Deletes this operation.
`String`	`description()` Returns an optional textual description of the operation.
`Long`	`endTime()` Returns the time that this operation was completed.
`boolean`	`equals(Object obj)`
`List<Operation.OperationError>`	`errors()` Returns the errors encountered while processing this operation, if any.
`boolean`	`exists()` Checks if this operation exists.
`String`	`generatedId()` Returns the service-generated unique identifier for the operation.
`int`	`hashCode()`
`String`	`httpErrorMessage()` Returns the the HTTP error message that was returned, if the operation failed.
`Integer`	`httpErrorStatusCode()` Returns the HTTP error status code that was returned, if the operation failed.
`Long`	`insertTime()` Returns the time that this operation was requested.
`boolean`	`isDone()` Checks if this operation has completed its execution, either failing or succeeding.
`<T extends OperationId> T`	`operationId()` Returns the operation's identity.
`String`	`operationType()` Returns the type of operation.
`Integer`	`progress()` Returns an optional progress indicator that ranges from 0 to 100.
`Operation`	`reload(Compute.OperationOption... options)` Fetches current operation's latest information.
`Long`	`startTime()` Returns the time that this operation was started by the service.
`Operation.Status`	`status()` Returns the status of the operation.
`String`	`statusMessage()` Returns an optional textual description of the current status of the operation.
`String`	`targetId()` Returns the unique service-defined target ID, which identifies the resource that the operation is modifying.
`String`	`targetLink()` Returns the URL of the resource that the operation is modifying.
`String`	`toString()`
`String`	`user()` Returns the user who requested the operation, for example: `user@example.com`.
`List<Operation.OperationWarning>`	`warnings()` Returns the warnings encountered while processing this operation, if any.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - compute
```
public Compute compute()
```
    Returns the operation's Compute object used to issue requests.
  - generatedId
```
public String generatedId()
```
    Returns the service-generated unique identifier for the operation.
  - operationId
```
public <T extends OperationId> T operationId()
```
    Returns the operation's identity. This method returns an GlobalOperationId for global operations, a RegionOperationId for region operations and a ZoneOperationId for zone operations.
    
    See Also:
    RFC1035
  - operationType
```
public String operationType()
```
    Returns the type of operation.
  - targetLink
```
public String targetLink()
```
    Returns the URL of the resource that the operation is modifying.
  - targetId
```
public String targetId()
```
    Returns the unique service-defined target ID, which identifies the resource that the operation is modifying.
  - status
```
public Operation.Status status()
```
    Returns the status of the operation.
  - statusMessage
```
public String statusMessage()
```
    Returns an optional textual description of the current status of the operation.
  - user
```
public String user()
```
    Returns the user who requested the operation, for example: user@example.com.
  - progress
```
public Integer progress()
```
    Returns 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.
  - insertTime
```
public Long insertTime()
```
    Returns the time that this operation was requested. In milliseconds since epoch.
  - startTime
```
public Long startTime()
```
    Returns the time that this operation was started by the service. In milliseconds since epoch. This value will be null if the operation has not started yet.
  - endTime
```
public Long endTime()
```
    Returns the time that this operation was completed. In milliseconds since epoch. This value will be null if the operation has not finished yet.
  - errors
```
public List<Operation.OperationError> errors()
```
    Returns the errors encountered while processing this operation, if any. Returns null if no error occurred.
  - warnings
```
public List<Operation.OperationWarning> warnings()
```
    Returns the warnings encountered while processing this operation, if any. Returns null if no warning occurred.
  - httpErrorStatusCode
```
public Integer httpErrorStatusCode()
```
    Returns the HTTP error status code that was returned, if the operation failed. For example, a 404 means the resource was not found.
  - httpErrorMessage
```
public String httpErrorMessage()
```
    Returns the the HTTP error message that was returned, if the operation failed. For example, a NOT FOUND message is returned if the resource was not found.
  - description
```
public String description()
```
    Returns an optional textual description of the operation.
  - exists
```
public boolean exists()
               throws ComputeException
```
    Checks if this operation exists.
    
    Returns:
    true if this operation exists, false otherwise
    
    Throws:
    
    ComputeException - upon failure
  - isDone
```
public boolean isDone()
               throws ComputeException
```
    Checks if this operation has completed its execution, either failing or succeeding. If the operation does not exist this method returns true. You can wait for operation completion with:
```
 while(!operation.isDone()) {
   Thread.sleep(1000L);
 }
```
    Returns:
    true if this operation is in Operation.Status.DONE state or if it does not exist, false if the state is not Operation.Status.DONE
    
    Throws:
    
    ComputeException - upon failure
  - reload
```
public Operation reload(Compute.OperationOption... options)
                 throws ComputeException
```
    Fetches current operation's latest information. Returns null if the operation does not exist.
    
    Parameters:
    options - operation options
    
    Returns:
    an Operation object with latest information or null if not found
    
    Throws:
    
    ComputeException - upon failure
  - delete
```
public boolean delete()
               throws ComputeException
```
    Deletes this operation. Delete is only possible for operations that have completed their execution. Any attempt to delete a running operation will fail.
    
    Returns:
    true if operation was deleted, false if it was not found
    
    Throws:
    
    ComputeException - upon failure
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Operation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compute

generatedId

operationId

operationType

targetLink

targetId

status

statusMessage

user

progress

insertTime

startTime

endTime

errors

warnings

httpErrorStatusCode

httpErrorMessage

description

exists

isDone

reload

delete

toString

hashCode

equals