com.google.api.services.drive.model

Class Operation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.drive.model.Operation

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

This resource represents a long-running operation that is the result of a network API call.

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 Google Drive 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/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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Operation()

Method Summary

Modifier and Type	Method and Description
Operation	clone()
Boolean	getDone() If the value is `false`, it means the operation is still in progress.
Status	getError() The error result of the operation in case of failure or cancellation.
Map<String,Object>	getMetadata() Service-specific metadata associated with the operation.
String	getName() The server-assigned name, which is only unique within the same service that originally returns it.
Map<String,Object>	getResponse() The normal, successful response of the operation.
Operation	set(String fieldName, Object value)
Operation	setDone(Boolean done) If the value is `false`, it means the operation is still in progress.
Operation	setError(Status error) The error result of the operation in case of failure or cancellation.
Operation	setMetadata(Map<String,Object> metadata) Service-specific metadata associated with the operation.
Operation	setName(String name) The server-assigned name, which is only unique within the same service that originally returns it.
Operation	setResponse(Map<String,Object> response) The normal, successful response of the operation.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

Operation

public Operation()

Method Detail

getDone

public Boolean getDone()

If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Returns:

value or null for none

setDone

public Operation setDone(Boolean done)

If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Parameters:

done - done or null for none

getError

public Status getError()

The error result of the operation in case of failure or cancellation.

Returns:

value or null for none

setError

public Operation setError(Status error)

The error result of the operation in case of failure or cancellation.

Parameters:

error - error or null for none

getMetadata

public Map<String,Object> getMetadata()

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

Returns:

value or null for none

setMetadata

public Operation setMetadata(Map<String,Object> metadata)

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

Parameters:

metadata - metadata or null for none

getName

public String getName()

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Returns:

value or null for none

setName

public Operation setName(String name)

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Parameters:

name - name or null for none

getResponse

public Map<String,Object> getResponse()

The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

Returns:

value or null for none

setResponse

public Operation setResponse(Map<String,Object> response)

The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

Parameters:

response - response or null for none

set

public Operation set(String fieldName,
                     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