Class Operation<TReq>

constructor

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

  Type Parameters

  • TReq

  Parameters

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

  Returns Operation<TReq>

Readonly$type

ReadonlyinnerType

[customJson]

• "[customJson]"(): unknown

  Returns unknown

createdAt

• createdAt(): Dayjs | undefined

  Operation creation timestamp if provided.

  Returns Dayjs | undefined

createdBy

• createdBy(): string

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

  Returns string

description

• description(): string

  Human-readable operation description.

  Returns string

done

• done(): boolean

  Returns true if the operation is completed.

  Returns boolean

finishedAt

• finishedAt(): Dayjs | undefined

  Operation completion timestamp if provided.

  Returns Dayjs | undefined

id

• id(): string

  Returns string

progressTracker

• progressTracker(): OperationProgressTracker | undefined

  Returns a progress tracker wrapper when available. For operations that do not provide progress details (or v1alpha1), this returns undefined.

  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

  Raw underlying protobuf object.

  Returns GenericOperation

resourceId

• resourceId(): string

  Resource ID associated with the operation.

  Returns string

status

• status(): Status | undefined

  Operation status if completed.

  Returns Status | undefined

successful

• successful(): boolean

  Returns true if operation status is OK.

  Returns boolean

toString

• toString(): string

  Returns string

update

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

  Fetch the latest operation state from the operation service.

  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?: Partial<CallOptions> & RetryOptions,
  ): Promise<void>

  Polls the operation until it completes.

  Parameters

  • intervalSec: number = 1

    polling interval in seconds (default: 1)

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

  Returns Promise<void>

  Example

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