View Source GoogleApi.ContentWarehouse.V1.Model.TrawlerFetchReplyDataPartialResponse (google_api_content_warehouse v0.4.0)

---------------------------------------------------------------------- PartialResponse is used with streaming responses in LargeFileFetchAdapter. Rather than fitting entirely in a single FetchReply, there is a series of FetchReplies until IsFinalResponse. Each group of responses will have a unique FetchID to link them.

Attributes

  • BodyLocation (type: String.t, default: nil) - If set, indicates where the fetched body is, e.g. a CNS file path. FetchReply.Body should be empty in this case. In the case where client does not support streaming but the content is too large to be accumulated in memory, we keep writing the streaming chunks to some storage unit and notify client when it is done.
  • ChunkNumber (type: integer(), default: nil) - Fetch number in this series of fetches
  • ContentRange (type: GoogleApi.ContentWarehouse.V1.Model.TrawlerContentRangeInfo.t, default: nil) - If there is a Content-Range header, the ranges in it
  • ETag (type: String.t, default: nil) - Any ETag seen in the headers
  • FetchID (type: String.t, default: nil) - ID which links all partial fetches for this url
  • IsFinalResponse (type: boolean(), default: nil) - Is this the final response for this fetch?

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.TrawlerFetchReplyDataPartialResponse{
    BodyLocation: String.t() | nil,
    ChunkNumber: integer() | nil,
    ContentRange:
      GoogleApi.ContentWarehouse.V1.Model.TrawlerContentRangeInfo.t() | nil,
    ETag: String.t() | nil,
    FetchID: String.t() | nil,
    IsFinalResponse: boolean() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.