MediaRequestInfo

Extra information added to operations that support Scotty media requests.

JSON representation
{
  "requestId": string,
  "notificationType": enum (NotificationType),
  "currentBytes": string,
  "totalBytes": string,
  "totalBytesIsEstimated": boolean,
  "customData": string,
  "diffObjectVersion": string,
  "finalStatus": integer,
  "requestReceivedParamsServingInfo": string,
  "physicalHeaders": string
}
Fields
requestId

string

The Scotty request ID.

notificationType

enum (NotificationType)

The type of notification received from Scotty.

currentBytes

string (int64 format)

The number of current bytes uploaded or downloaded.

totalBytes

string (int64 format)

The total size of the file.

totalBytesIsEstimated

boolean

Whether the total bytes field contains an estimated data.

customData

string

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

diffObjectVersion

string

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.

finalStatus

integer

The existence of the finalStatus field indicates that this is the last call to the agent for this requestId.

requestReceivedParamsServingInfo

string (bytes format)

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

A base64-encoded string.

physicalHeaders

string (bytes format)

The physical headers provided by the request received parameters.

A base64-encoded string.