Operation (Google Cloud 0.119.0-alpha API)

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

All Implemented Interfaces:

Serializable
```
public class Operation
extends Object
implements Serializable
```
Google Compute Engine operations. Operation identity can be obtained via getOperationId(). getOperationId() 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(Compute.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`delete()` Deletes this operation.
`boolean`	`equals(Object obj)`
`boolean`	`exists()` Checks if this operation exists.
`Compute`	`getCompute()` Returns the operation's `Compute` object used to issue requests.
`String`	`getDescription()` Returns an optional textual description of the operation.
`Long`	`getEndTime()` Returns the time that this operation was completed.
`List<Operation.OperationError>`	`getErrors()` Returns the errors encountered while processing this operation, if any.
`String`	`getGeneratedId()` Returns the service-generated unique identifier for the operation.
`String`	`getHttpErrorMessage()` Returns the the HTTP error message that was returned, if the operation failed.
`Integer`	`getHttpErrorStatusCode()` Returns the HTTP error status code that was returned, if the operation failed.
`Long`	`getInsertTime()` Returns the time that this operation was requested.
`<T extends OperationId> T`	`getOperationId()` Returns the operation's identity.
`String`	`getOperationType()` Returns the type of operation.
`Integer`	`getProgress()` Returns an optional progress indicator that ranges from 0 to 100.
`Long`	`getStartTime()` Returns the time that this operation was started by the service.
`Operation.Status`	`getStatus()` Returns the status of the operation.
`String`	`getStatusMessage()` Returns an optional textual description of the current status of the operation.
`String`	`getTargetId()` Returns the unique service-defined target ID, which identifies the resource that the operation is modifying.
`String`	`getTargetLink()` Returns the URL of the resource that the operation is modifying.
`String`	`getUser()` Returns the user who requested the operation, for example: `user@example.com`.
`List<Operation.OperationWarning>`	`getWarnings()` Returns the warnings encountered while processing this operation, if any.
`int`	`hashCode()`
`boolean`	`isDone()` Checks if this operation has completed its execution, either failing or succeeding.
`Operation`	`reload(Compute.OperationOption... options)` Fetches current operation's latest information.
`String`	`toString()`
`Operation`	`waitFor(com.google.cloud.RetryOption... waitOptions)` Blocks until this operation completes its execution, either failing or succeeding.

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

- Method Detail
  - getCompute
```
public Compute getCompute()
```
    Returns the operation's Compute object used to issue requests.
  - getGeneratedId
```
public String getGeneratedId()
```
    Returns the service-generated unique identifier for the operation.
  - getOperationId
```
public <T extends OperationId> T getOperationId()
```
    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
  - getOperationType
```
public String getOperationType()
```
    Returns the type of operation.
  - getTargetLink
```
public String getTargetLink()
```
    Returns the URL of the resource that the operation is modifying.
  - getTargetId
```
public String getTargetId()
```
    Returns the unique service-defined target ID, which identifies the resource that the operation is modifying.
  - getStatus
```
public Operation.Status getStatus()
```
    Returns the status of the operation.
  - getStatusMessage
```
public String getStatusMessage()
```
    Returns an optional textual description of the current status of the operation.
  - getUser
```
public String getUser()
```
    Returns the user who requested the operation, for example: user@example.com.
  - getProgress
```
public Integer getProgress()
```
    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.
  - getInsertTime
```
public Long getInsertTime()
```
    Returns the time that this operation was requested. In milliseconds since epoch.
  - getStartTime
```
public Long getStartTime()
```
    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.
  - getEndTime
```
public Long getEndTime()
```
    Returns the time that this operation was completed. In milliseconds since epoch. This value will be null if the operation has not finished yet.
  - getErrors
```
public List<Operation.OperationError> getErrors()
```
    Returns the errors encountered while processing this operation, if any. Returns null if no error occurred.
  - getWarnings
```
public List<Operation.OperationWarning> getWarnings()
```
    Returns the warnings encountered while processing this operation, if any. Returns null if no warning occurred.
  - getHttpErrorStatusCode
```
public Integer getHttpErrorStatusCode()
```
    Returns the HTTP error status code that was returned, if the operation failed. For example, a 404 means the resource was not found.
  - getHttpErrorMessage
```
public String getHttpErrorMessage()
```
    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.
  - getDescription
```
public String getDescription()
```
    Returns an optional textual description of the operation.
  - exists
```
public boolean exists()
```
    Checks if this operation exists.
    
    Returns:
    
    true if this operation exists, false otherwise
    
    Throws:
    
    ComputeException - upon failure
  - isDone
```
public boolean isDone()
```
    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
  - waitFor
```
public Operation waitFor(com.google.cloud.RetryOption... waitOptions)
                  throws InterruptedException
```
    Blocks until this operation completes its execution, either failing or succeeding. This method returns current operation's latest information. If the operation no longer exists, this method returns null. By default, the operation status is checked using jittered exponential backoff with 1 second as an initial delay, 2.0 as a backoff factor, 1 minute as maximum delay between polls, 12 hours as a total timeout and unlimited number of attempts.
    Example usage of waitFor():
```
 Operation completedOperation = operation.waitFor();
 if (completedOperation == null) {
   // operation no longer exists
 } else if (completedOperation.errors() != null) {
   // operation failed, handle error
 } else {
   // operation completed successfully
 }
 
```
    Example usage of waitFor() with checking period and timeout:
```
 Operation completedOperation =
     operation.waitFor(
         RetryOption.maxRetryDelay(Duration.ofSeconds(30)),
         RetryOption.totalTimeout(Duration.ofMinutes(1)),
         RetryOption.jittered(false));
 if (completedOperation == null) {
   // operation no longer exists
 } else if (completedOperation.errors() != null) {
   // operation failed, handle error
 } else {
   // operation completed successfully
 }
 
```
    Parameters:
    
    waitOptions - options to configure checking period and timeout
    
    Throws:
    
    ComputeException - upon failure, check Throwable.getCause() for details
    
    InterruptedException - if the current thread gets interrupted while waiting for the operation to complete
  - reload
```
public Operation reload(Compute.OperationOption... options)
```
    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()
```
    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

getCompute

getGeneratedId

getOperationId

getOperationType

getTargetLink

getTargetId

getStatus

getStatusMessage

getUser

getProgress

getInsertTime

getStartTime

getEndTime

getErrors

getWarnings

getHttpErrorStatusCode

getHttpErrorMessage

getDescription

exists

isDone

waitFor

reload

delete

toString

hashCode

equals