Class Operation<TReq>

constructor

• new Operation<TReq>(
      _op: GenericOperation,
      service: OperationService<TReq>,
      logger: Logger,
  ): Operation<TReq>

  Creates an operation wrapper.

  Generated clients create this object with the correct operation service. Application code normally receives it from a service request. Invalid IDs and timestamps throw OperationValidationError.

  Type Parameters

  • TReq

  Parameters

  • _op: GenericOperation
  • service: OperationService<TReq>
  • logger: Logger

  Returns Operation<TReq>

Readonly$type

ReadonlyinnerType

[customJson]

• "[customJson]"(): unknown

  Returns a JSON-safe value for logs.

  Returns unknown

createdAt

• createdAt(): Dayjs | undefined

  Returns the operation creation time.

  Returns Dayjs | undefined

createdBy

• createdBy(): string

  Returns the ID of the user or service account that created the operation.

  Returns string

description

• description(): string

  Returns the human-readable operation description.

  Returns string

done

• done(): boolean

  Checks whether the service has returned a final status.

  Returns boolean

finishedAt

• finishedAt(): Dayjs | undefined

  Returns the operation finish time.

  Returns Dayjs | undefined

id

• id(): string

  Returns the operation ID.

  Returns string

progressData

• progressData(registry?: Registry): MessageInstanceInterface | undefined

  Decodes service-specific progress data using registered message codecs.

  Parameters

  • registry: Registry = protoRegistry

  Returns MessageInstanceInterface | undefined

progressTracker

• progressTracker(): OperationProgressTracker | undefined

  Returns the progress tracker.

  Returns undefined when the service does not provide progress.

  Returns OperationProgressTracker | undefined

  Example

  const tracker = op.progressTracker();
  if (tracker) {
    console.log(tracker.description());
    const steps = tracker.steps();
    if (steps.length > 0) console.log('first step', steps[0].description());
  }
  Copy

raw

• raw(): GenericOperation

  Returns the latest source protobuf object.

  Treat this object as read-only. update replaces it with the next response from the service.

  Returns GenericOperation

request

• request(registry?: Registry): MessageInstanceInterface | undefined

  Decodes the original operation request using registered message codecs.

  Parameters

  • registry: Registry = protoRegistry

  Returns MessageInstanceInterface | undefined

requestHeaders

• requestHeaders(): Record<string, string[]>

  Copies the saved request headers.

  Returns Record<string, string[]>

resource

• resource(registry?: Registry): MessageInstanceInterface | undefined

  Decodes the alpha resource snapshot captured when the operation started.

  Parameters

  • registry: Registry = protoRegistry

  Returns MessageInstanceInterface | undefined

resourceId

• resourceId(): string

  Returns the affected resource ID.

  A service can return an empty string before it assigns the resource ID.

  Returns string

status

• status(): Status | undefined

  Returns the final status, or undefined while the operation is running.

  Returns Status | undefined

successful

• successful(): boolean

  Checks whether the operation finished successfully.

  Returns false while the operation is still running.

  Returns boolean

toString

• toString(): string

  Converts the value to string.

  Returns string

update

• update(
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Promise<void>

  Gets the latest operation state from the operation service.

  The method refreshes the wrapped state in place. Request errors reject the returned promise.

  Parameters

  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns Promise<void>

  Example

  await op.update();
  if (op.done()) console.log('finished', op.status());
  Copy

wait

• wait(
      intervalSec?: number,
      metadata?: Metadata,
      options?: OperationWaitOptions & Partial<CallOptions>,
  ): Promise<void>

  Polls the operation until the service returns a final status.

  The method updates this object in place. It continues after a polling call reaches its per-attempt deadline, because the remote operation can still be running. Consecutive retriable polling errors use exponential backoff with jitter. It rethrows non-retriable polling errors and rejects failed operations. A resolved promise means that the operation succeeded. The caller deadline, timeoutMs, or AbortSignal stops local waiting without canceling the remote operation.

  Parameters

  • intervalSec: number = DEFAULT_POLL_INTERVAL_SEC

    Sets the poll interval in seconds. Non-positive values use the default of 1.

  • Optionalmetadata: Metadata

    Sends metadata with every polling request.

  • Optionaloptions: OperationWaitOptions & Partial<CallOptions>

    Sets gRPC deadlines, request retries, and poll-error backoff.

  Returns Promise<void>

  Example

  await op.wait(1); // poll once per second
  Copy