Class UploadCompleteParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class UploadCompleteParams implements Params
Completes the Upload.
Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
UploadCompleteParams.Builder
A builder for UploadCompleteParams.
public final class
UploadCompleteParams.Body
-
Method Summary
Modifier and Type Method Description final String
uploadId()
final List<String>
partIds()
The ordered list of Part IDs. final Optional<String>
md5()
The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect. final JsonField<List<String>>
_partIds()
Returns the raw JSON value of partIds. final JsonField<String>
_md5()
Returns the raw JSON value of md5. final Map<String, JsonValue>
_additionalBodyProperties()
final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final UploadCompleteParams.Builder
toBuilder()
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 UploadCompleteParams.Builder
builder()
Returns a mutable builder for constructing an instance of UploadCompleteParams. -
-
Method Detail
-
md5
final Optional<String> md5()
The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.
-
_partIds
final JsonField<List<String>> _partIds()
Returns the raw JSON value of partIds.
Unlike partIds, this method doesn't throw if the JSON field has an unexpected type.
-
_md5
final JsonField<String> _md5()
Returns the raw JSON value of md5.
Unlike md5, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final UploadCompleteParams.Builder toBuilder()
-
_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 UploadCompleteParams.Builder builder()
Returns a mutable builder for constructing an instance of UploadCompleteParams.
The following fields are required:
.uploadId() .partIds()
-
-
-
-