Interface OperationService<TReq>

Defines the operation service method that Operation uses for polling.

Generated operation service clients satisfy this interface.

interface OperationService<TReq> {
    get(
        req: { id: string },
        metadata?: Metadata,
        options?: Partial<CallOptions> & RetryOptions,
    ): Request<TReq, Operation<TReq>>;
}

Type Parameters

TReq

Index

Methods

get

Methods

get

get(
    req: { id: string },
    metadata?: Metadata,
    options?: Partial<CallOptions> & RetryOptions,
): Request<TReq, Operation<TReq>>
Gets the latest state of an operation.
Parameters
- req: { id: string }
  - id: string
    
    Contains the ID.
- Optionalmetadata: Metadata
- Optionaloptions: Partial<CallOptions> & RetryOptions
Returns Request<TReq, Operation<TReq>>
- Defined in src/runtime/operation.ts:215

Interface OperationService<TReq>

Type Parameters

Index

Methods

Methods

get

Parameters

id: string

Returns Request<TReq, Operation<TReq>>

Settings

On This Page