Uploads rotating barcode values for the transit object referenced by the given object ID. Note the max upload size is specified in google3/production/config/cdd/apps-upload/customers/payments-consumer-passes/config.gcl and enforced by Scotty.

Scopes

You will need authorization for the https://www.googleapis.com/auth/wallet_object.issuer scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/wallet_object.issuer. You can set the scope for this method like this: walletobjects1 --scope <scope> media upload ...

Required Scalar Argument

  • <resource-id> (string)
    • The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

TransitObjectUploadRotatingBarcodeValuesRequest:
  blob:
    algorithm: string
    bigstore-object-ref: string
    blob-ref: string
    blobstore2-info:
      blob-generation: string
      blob-id: string
      download-read-handle: string
      read-token: string
      upload-metadata-container: string
    content-type: string
    content-type-info:
      best-guess: string
      from-bytes: string
      from-file-name: string
      from-header: string
      from-url-path: string
    cosmo-binary-reference: string
    crc32c-hash: integer
    diff-checksums-response:
      checksums-location:
        blob-ref: string
        blobstore2-info:
          blob-generation: string
          blob-id: string
          download-read-handle: string
          read-token: string
          upload-metadata-container: string
        cosmo-binary-reference: string
        crc32c-hash: integer
        inline: string
        length: string
        md5-hash: string
        object-id:
          bucket-name: string
          generation: string
          object-name: string
        path: string
        reference-type: string
        sha1-hash: string
      chunk-size-bytes: string
      object-location:
        blob-ref: string
        blobstore2-info:
          blob-generation: string
          blob-id: string
          download-read-handle: string
          read-token: string
          upload-metadata-container: string
        cosmo-binary-reference: string
        crc32c-hash: integer
        inline: string
        length: string
        md5-hash: string
        object-id:
          bucket-name: string
          generation: string
          object-name: string
        path: string
        reference-type: string
        sha1-hash: string
      object-size-bytes: string
      object-version: string
    diff-download-response:
      object-location:
        blob-ref: string
        blobstore2-info:
          blob-generation: string
          blob-id: string
          download-read-handle: string
          read-token: string
          upload-metadata-container: string
        cosmo-binary-reference: string
        crc32c-hash: integer
        inline: string
        length: string
        md5-hash: string
        object-id:
          bucket-name: string
          generation: string
          object-name: string
        path: string
        reference-type: string
        sha1-hash: string
    diff-upload-request:
      checksums-info:
        blob-ref: string
        blobstore2-info:
          blob-generation: string
          blob-id: string
          download-read-handle: string
          read-token: string
          upload-metadata-container: string
        cosmo-binary-reference: string
        crc32c-hash: integer
        inline: string
        length: string
        md5-hash: string
        object-id:
          bucket-name: string
          generation: string
          object-name: string
        path: string
        reference-type: string
        sha1-hash: string
      object-info:
        blob-ref: string
        blobstore2-info:
          blob-generation: string
          blob-id: string
          download-read-handle: string
          read-token: string
          upload-metadata-container: string
        cosmo-binary-reference: string
        crc32c-hash: integer
        inline: string
        length: string
        md5-hash: string
        object-id:
          bucket-name: string
          generation: string
          object-name: string
        path: string
        reference-type: string
        sha1-hash: string
      object-version: string
    diff-upload-response:
      object-version: string
      original-object:
        blob-ref: string
        blobstore2-info:
          blob-generation: string
          blob-id: string
          download-read-handle: string
          read-token: string
          upload-metadata-container: string
        cosmo-binary-reference: string
        crc32c-hash: integer
        inline: string
        length: string
        md5-hash: string
        object-id:
          bucket-name: string
          generation: string
          object-name: string
        path: string
        reference-type: string
        sha1-hash: string
    diff-version-response:
      object-size-bytes: string
      object-version: string
    download-parameters:
      allow-gzip-compression: boolean
      ignore-range: boolean
    filename: string
    hash: string
    hash-verified: boolean
    inline: string
    is-potential-retry: boolean
    length: string
    md5-hash: string
    media-id: string
    object-id:
      bucket-name: string
      generation: string
      object-name: string
    path: string
    reference-type: string
    sha1-hash: string
    sha256-hash: string
    timestamp: string
    token: string
  media-request-info:
    current-bytes: string
    custom-data: string
    diff-object-version: string
    final-status: integer
    notification-type: string
    request-id: string
    request-received-params-serving-info: string
    total-bytes: string
    total-bytes-is-estimated: boolean

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .blob algorithm=nonumy
    • Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
  • bigstore-object-ref=rebum.
    • Use object_id instead.
  • blob-ref=ipsum
    • Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
  • blobstore2-info blob-generation=et
    • The blob generation id.
  • blob-id=vero
    • The blob id, e.g., /blobstore/prod/playground/scotty
  • download-read-handle=elitr
    • Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
  • read-token=consetetur
    • The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.

  • upload-metadata-container=dolor

    • Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.

  • .. content-type=voluptua.

    • MIME type of the data
  • content-type-info best-guess=eirmod
    • Scotty's best guess of what the content type of the file is.
  • from-bytes=accusam
    • The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
  • from-file-name=est
    • The content type of the file derived from the file extension of the original file name used by the client.
  • from-header=et
    • The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.

  • from-url-path=at

    • The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).

  • .. cosmo-binary-reference=magna

    • A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
  • crc32c-hash=9
    • For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
  • diff-checksums-response.checksums-location blob-ref=sadipscing
    • Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
  • blobstore2-info blob-generation=amet
    • The blob generation id.
  • blob-id=tempor
    • The blob id, e.g., /blobstore/prod/playground/scotty
  • download-read-handle=tempor
    • Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
  • read-token=et
    • The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.

  • upload-metadata-container=gubergren

    • Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.

  • .. cosmo-binary-reference=et

    • A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
  • crc32c-hash=61
    • crc32.c hash for the payload.
  • inline=dolor
    • Media data, set if reference_type is INLINE
  • length=rebum.
    • Size of the data, in bytes
  • md5-hash=nonumy
    • MD5 hash for the payload.
  • object-id bucket-name=kasd
    • The name of the bucket to which this object belongs.
  • generation=ut
    • Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions

  • object-name=dolores

    • The name of the object.

  • .. path=lorem

    • Path to the data, set if reference_type is PATH
  • reference-type=justo
    • Describes what the field reference contains.

  • sha1-hash=nonumy

    • SHA-1 hash for the payload.

  • .. chunk-size-bytes=kasd

    • The chunk size of checksums. Must be a multiple of 256KB.
  • object-location blob-ref=invidunt
    • Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
  • blobstore2-info blob-generation=ipsum
    • The blob generation id.
  • blob-id=no
    • The blob id, e.g., /blobstore/prod/playground/scotty
  • download-read-handle=diam
    • Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
  • read-token=stet
    • The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.

  • upload-metadata-container=dolor

    • Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.

  • .. cosmo-binary-reference=sit

    • A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
  • crc32c-hash=41
    • crc32.c hash for the payload.
  • inline=dolores
    • Media data, set if reference_type is INLINE
  • length=elitr
    • Size of the data, in bytes
  • md5-hash=takimata
    • MD5 hash for the payload.
  • object-id bucket-name=dolor
    • The name of the bucket to which this object belongs.
  • generation=voluptua.
    • Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions

  • object-name=vero

    • The name of the object.

  • .. path=ea

    • Path to the data, set if reference_type is PATH
  • reference-type=rebum.
    • Describes what the field reference contains.

  • sha1-hash=dolor

    • SHA-1 hash for the payload.

  • .. object-size-bytes=ipsum

    • The total size of the server object.

  • object-version=labore

    • The object version of the object the checksums are being returned for.

  • ..diff-download-response.object-location blob-ref=ipsum

    • Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
  • blobstore2-info blob-generation=consetetur
    • The blob generation id.
  • blob-id=eos
    • The blob id, e.g., /blobstore/prod/playground/scotty
  • download-read-handle=et
    • Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
  • read-token=dolore
    • The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.

  • upload-metadata-container=accusam

    • Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.

  • .. cosmo-binary-reference=sed

    • A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
  • crc32c-hash=54
    • crc32.c hash for the payload.
  • inline=et
    • Media data, set if reference_type is INLINE
  • length=at
    • Size of the data, in bytes
  • md5-hash=accusam
    • MD5 hash for the payload.
  • object-id bucket-name=sea
    • The name of the bucket to which this object belongs.
  • generation=et
    • Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions

  • object-name=ea

    • The name of the object.

  • .. path=aliquyam

    • Path to the data, set if reference_type is PATH
  • reference-type=nonumy
    • Describes what the field reference contains.

  • sha1-hash=sit

    • SHA-1 hash for the payload.

  • ...diff-upload-request.checksums-info blob-ref=lorem

    • Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
  • blobstore2-info blob-generation=ipsum
    • The blob generation id.
  • blob-id=tempor
    • The blob id, e.g., /blobstore/prod/playground/scotty
  • download-read-handle=erat
    • Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
  • read-token=at
    • The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.

  • upload-metadata-container=gubergren

    • Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.

  • .. cosmo-binary-reference=eos

    • A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
  • crc32c-hash=3
    • crc32.c hash for the payload.
  • inline=kasd
    • Media data, set if reference_type is INLINE
  • length=et
    • Size of the data, in bytes
  • md5-hash=eirmod
    • MD5 hash for the payload.
  • object-id bucket-name=sanctus
    • The name of the bucket to which this object belongs.
  • generation=ipsum
    • Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions

  • object-name=dolor

    • The name of the object.

  • .. path=ipsum

    • Path to the data, set if reference_type is PATH
  • reference-type=dolor
    • Describes what the field reference contains.

  • sha1-hash=tempor

    • SHA-1 hash for the payload.

  • ..object-info blob-ref=rebum.

    • Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
  • blobstore2-info blob-generation=sed
    • The blob generation id.
  • blob-id=justo
    • The blob id, e.g., /blobstore/prod/playground/scotty
  • download-read-handle=voluptua.
    • Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
  • read-token=consetetur
    • The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.

  • upload-metadata-container=lorem

    • Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.

  • .. cosmo-binary-reference=ipsum

    • A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
  • crc32c-hash=82
    • crc32.c hash for the payload.
  • inline=vero
    • Media data, set if reference_type is INLINE
  • length=lorem
    • Size of the data, in bytes
  • md5-hash=dolores
    • MD5 hash for the payload.
  • object-id bucket-name=diam
    • The name of the bucket to which this object belongs.
  • generation=erat
    • Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions

  • object-name=dolor

    • The name of the object.

  • .. path=invidunt

    • Path to the data, set if reference_type is PATH
  • reference-type=ut
    • Describes what the field reference contains.

  • sha1-hash=rebum.

    • SHA-1 hash for the payload.

  • .. object-version=erat

    • The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.

  • ..diff-upload-response object-version=at

    • The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
  • original-object blob-ref=sed
    • Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
  • blobstore2-info blob-generation=takimata
    • The blob generation id.
  • blob-id=invidunt
    • The blob id, e.g., /blobstore/prod/playground/scotty
  • download-read-handle=sadipscing
    • Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
  • read-token=diam
    • The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.

  • upload-metadata-container=sed

    • Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.

  • .. cosmo-binary-reference=sanctus

    • A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
  • crc32c-hash=54
    • crc32.c hash for the payload.
  • inline=justo
    • Media data, set if reference_type is INLINE
  • length=aliquyam
    • Size of the data, in bytes
  • md5-hash=et
    • MD5 hash for the payload.
  • object-id bucket-name=sadipscing
    • The name of the bucket to which this object belongs.
  • generation=accusam
    • Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions

  • object-name=justo

    • The name of the object.

  • .. path=diam

    • Path to the data, set if reference_type is PATH
  • reference-type=sea
    • Describes what the field reference contains.

  • sha1-hash=consetetur

    • SHA-1 hash for the payload.

  • ...diff-version-response object-size-bytes=tempor

    • The total size of the server object.

  • object-version=duo

    • The version of the object stored at the server.

  • ..download-parameters allow-gzip-compression=true

    • A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.

  • ignore-range=false

    • Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.

  • .. filename=diam

    • Original file name
  • hash=justo
    • Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/uploader/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
  • hash-verified=false
    • For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
  • inline=ipsum
    • Media data, set if reference_type is INLINE
  • is-potential-retry=false
    • |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
  • length=sed
    • Size of the data, in bytes
  • md5-hash=et
    • Scotty-provided MD5 hash for an upload.
  • media-id=no
    • Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
  • object-id bucket-name=diam
    • The name of the bucket to which this object belongs.
  • generation=vero
    • Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions

  • object-name=et

    • The name of the object.

  • .. path=et

    • Path to the data, set if reference_type is PATH
  • reference-type=eirmod
    • Describes what the field reference contains.
  • sha1-hash=dolore
    • Scotty-provided SHA1 hash for an upload.
  • sha256-hash=sea
    • Scotty-provided SHA256 hash for an upload.
  • timestamp=sadipscing
    • Time at which the media data was last updated, in milliseconds since UNIX epoch

  • token=ea

    • A unique fingerprint/version id for the media data

  • ..media-request-info current-bytes=sadipscing

    • The number of current bytes uploaded or downloaded.
  • custom-data=erat
    • 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.
  • diff-object-version=erat
    • 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.
  • final-status=94
    • 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
  • notification-type=lorem
    • The type of notification received from Scotty.
  • request-id=gubergren
    • The Scotty request ID.
  • request-received-params-serving-info=erat
    • The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()
  • total-bytes=nonumy
    • The total size of the file.
  • total-bytes-is-estimated=true
    • Whether the total bytes field contains an estimated data.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Required Upload Flags

This method supports the upload of data, which requires all of the following flags to be set:

  • -u simple
    • simple - Upload media all at once.
  • -f file
    • Path to file to upload. It must be seekable.

The following flag may be set:

  • -m mime
    • the mime type, like 'application/octet-stream', which is the default

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").