Interface Operation<T>

A long-running operation.

interface Operation<T> {
    done?: boolean;
    error?: Record<string, unknown>;
    metadata?: Record<string, unknown>;
    name?: string;
    response?: T;
}

Type Parameters

  • T

Implemented by

Properties

done? error? metadata? name? response?

Properties

Optionaldone

done?: boolean

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.

Optionalerror

error?: Record<string, unknown>

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

Optionalmetadata

metadata?: Record<string, unknown>

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.

Optionalname

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, the name should be a resource name ending with operations/{unique_id}.

Optionalresponse

response?: T

The response if the operation is successful.

Settings

On This Page

Properties