Announcement: All noncommercial projects registered to use Earth Engine beforeApril 15, 2025 mustverify noncommercial eligibility to maintain access. If you have not verified by September 26, 2025, your access may be on hold.

REST Resource: projects.operations

  • An Operation resource represents a long-running operation resulting from a network API call.

  • An Operation has fields for its name, service-specific metadata, and a booleandone indicating completion.

  • Upon completion (done is true), an Operation will have either anerror or aresponse field set.

  • Operations can be managed using methods likecancel,delete,get,list, andwait.

Resource: Operation

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

JSON representation
{"name":string,"metadata":{"@type":string,field1:...,...},"done":boolean,// Union fieldresult can be only one of the following:"error":{object (Status)},"response":{"@type":string,field1:...,...}// End of list of possible types for union fieldresult.}
Fields
name

string

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

metadata

object

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.

An object containing fields of an arbitrary type. An additional field"@type" contains a URI identifying the type. Example:{ "id": 1234, "@type": "types.example.com/standard/id" }.

done

boolean

If the value isfalse, it means the operation is still in progress. Iftrue, the operation is completed, and eithererror orresponse is available.

Union fieldresult. The operation result, which can be either anerror or a validresponse. Ifdone ==false, neithererror norresponse is set. Ifdone ==true, exactly one oferror orresponse can be set. Some services might not provide the result.result can be only one of the following:
error

object (Status)

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

response

object

The normal, successful response of the operation. If the original method returns no data on success, such asDelete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxx is the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse.

An object containing fields of an arbitrary type. An additional field"@type" contains a URI identifying the type. Example:{ "id": 1234, "@type": "types.example.com/standard/id" }.

Methods

cancel

 Starts asynchronous cancellation on a long-running operation.

delete

 Deletes a long-running operation.

get

 Gets the latest state of a long-running operation.

list

 Lists operations that match the specified filter in the request.

wait

 Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-06-05 UTC.