MediaRequestInfo

import type { MediaRequestInfo } from "https://googleapis.deno.dev/v1/walletobjects:v1.ts";

Extra information added to operations that support Scotty media requests.

interface MediaRequestInfo {

currentBytes?: bigint;

customData?: string;

diffObjectVersion?: string;

finalStatus?: number;

notificationType?:

| "START"

| "PROGRESS"

| "END"

| "RESPONSE_SENT"

| "ERROR";

requestId?: string;

requestReceivedParamsServingInfo?: Uint8Array;

totalBytes?: bigint;

totalBytesIsEstimated?: boolean;

}

§Properties

currentBytes?: bigint

[src]

The number of current bytes uploaded or downloaded.

customData?: string

[src]

Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.

diffObjectVersion?: string

[src]

Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.

finalStatus?: number

[src]

The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929

notificationType?: "START" | "PROGRESS" | "END" | "RESPONSE_SENT" | "ERROR"

[src]

The type of notification received from Scotty.

requestId?: string

[src]

The Scotty request ID.

requestReceivedParamsServingInfo?: Uint8Array

[src]

The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()

totalBytes?: bigint

[src]

The total size of the file.

totalBytesIsEstimated?: boolean

[src]

Whether the total bytes field contains an estimated data.