Constructor Detail

Method Detail

• body

   final UploadCreateParams.Builder body(UploadCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • bytes

  • filename

  • mimeType

  • purpose

  • expiresAfter

  • etc.

• bytes

   final UploadCreateParams.Builder bytes(Long bytes)

  The number of bytes in the file you are uploading.

• bytes

   final UploadCreateParams.Builder bytes(JsonField<Long> bytes)

  Sets Builder.bytes to an arbitrary JSON value.

  You should usually call Builder.bytes with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• filename

   final UploadCreateParams.Builder filename(String filename)

  The name of the file to upload.

• filename

   final UploadCreateParams.Builder filename(JsonField<String> filename)

  Sets Builder.filename to an arbitrary JSON value.

  You should usually call Builder.filename with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• mimeType

   final UploadCreateParams.Builder mimeType(String mimeType)

  The MIME type of the file.

  This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.

• mimeType

   final UploadCreateParams.Builder mimeType(JsonField<String> mimeType)

  Sets Builder.mimeType to an arbitrary JSON value.

  You should usually call Builder.mimeType with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• purpose

   final UploadCreateParams.Builder purpose(FilePurpose purpose)

  The intended purpose of the uploaded file.

  See the documentation on File purposes.

• purpose

   final UploadCreateParams.Builder purpose(JsonField<FilePurpose> purpose)

  Sets Builder.purpose to an arbitrary JSON value.

  You should usually call Builder.purpose with a well-typed FilePurpose value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• expiresAfter

   final UploadCreateParams.Builder expiresAfter(UploadCreateParams.ExpiresAfter expiresAfter)

  The expiration policy for a file. By default, files with purpose=batch expire after 30 days and all other files are persisted until they are manually deleted.

• expiresAfter

   final UploadCreateParams.Builder expiresAfter(JsonField<UploadCreateParams.ExpiresAfter> expiresAfter)

  Sets Builder.expiresAfter to an arbitrary JSON value.

  You should usually call Builder.expiresAfter with a well-typed ExpiresAfter value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final UploadCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final UploadCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final UploadCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final UploadCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final UploadCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final UploadCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final UploadCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final UploadCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final UploadCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final UploadCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final UploadCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final UploadCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final UploadCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final UploadCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final UploadCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final UploadCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final UploadCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final UploadCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final UploadCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final UploadCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final UploadCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final UploadCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final UploadCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final UploadCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final UploadCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final UploadCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final UploadCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final UploadCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final UploadCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final UploadCreateParams build()

  Returns an immutable instance of UploadCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .bytes()
  .filename()
  .mimeType()
  .purpose()