Class PartCreateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class PartCreateParams implements Params
Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload.
Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.
It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
PartCreateParams.Builder
A builder for PartCreateParams.
public final class
PartCreateParams.Body
-
Method Summary
Modifier and Type Method Description final Optional<String>
uploadId()
final InputStream
data()
The chunk of bytes for this Part. final MultipartField<InputStream>
_data()
Returns the raw multipart value of data. final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final PartCreateParams.Builder
toBuilder()
final Map<String, MultipartField<?>>
_body()
final String
_pathParam(Integer index)
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static PartCreateParams.Builder
builder()
Returns a mutable builder for constructing an instance of PartCreateParams. -
-
Method Detail
-
data
final InputStream data()
The chunk of bytes for this Part.
-
_data
final MultipartField<InputStream> _data()
Returns the raw multipart value of data.
Unlike data, this method doesn't throw if the multipart field has an unexpected type.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final PartCreateParams.Builder toBuilder()
-
_body
final Map<String, MultipartField<?>> _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static PartCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of PartCreateParams.
The following fields are required:
.data()
-
-
-
-