Class CaseFile.Builder
-
- All Implemented Interfaces:
public final class CaseFile.BuilderA builder for CaseFile.
-
-
Method Summary
Modifier and Type Method Description final CaseFile.Buildertoken(String token)Globally unique identifier for the file final CaseFile.Buildertoken(JsonField<String> token)Sets Builder.token to an arbitrary JSON value. final CaseFile.Buildercreated(OffsetDateTime created)Date and time at which the file record was created final CaseFile.Buildercreated(JsonField<OffsetDateTime> created)Sets Builder.created to an arbitrary JSON value. final CaseFile.BuilderdownloadUrl(String downloadUrl)Presigned URL the client uses to download the file final CaseFile.BuilderdownloadUrl(Optional<String> downloadUrl)Alias for calling Builder.downloadUrl with downloadUrl.orElse(null).final CaseFile.BuilderdownloadUrl(JsonField<String> downloadUrl)Sets Builder.downloadUrl to an arbitrary JSON value. final CaseFile.BuilderdownloadUrlExpires(OffsetDateTime downloadUrlExpires)Date and time at which the download URL expires final CaseFile.BuilderdownloadUrlExpires(Optional<OffsetDateTime> downloadUrlExpires)Alias for calling Builder.downloadUrlExpires with downloadUrlExpires.orElse(null).final CaseFile.BuilderdownloadUrlExpires(JsonField<OffsetDateTime> downloadUrlExpires)Sets Builder.downloadUrlExpires to an arbitrary JSON value. final CaseFile.BuilderfailureReason(String failureReason)Reason the file was rejected, when applicable final CaseFile.BuilderfailureReason(Optional<String> failureReason)Alias for calling Builder.failureReason with failureReason.orElse(null).final CaseFile.BuilderfailureReason(JsonField<String> failureReason)Sets Builder.failureReason to an arbitrary JSON value. final CaseFile.BuildermimeType(String mimeType)MIME type of the file, available once the file is ready final CaseFile.BuildermimeType(Optional<String> mimeType)Alias for calling Builder.mimeType with mimeType.orElse(null).final CaseFile.BuildermimeType(JsonField<String> mimeType)Sets Builder.mimeType to an arbitrary JSON value. final CaseFile.Buildername(String name)Name of the file final CaseFile.Buildername(JsonField<String> name)Sets Builder.name to an arbitrary JSON value. final CaseFile.BuildersizeBytes(Long sizeBytes)Size of the file in bytes, available once the file is ready final CaseFile.BuildersizeBytes(Long sizeBytes)Alias for Builder.sizeBytes. final CaseFile.BuildersizeBytes(Optional<Long> sizeBytes)Alias for calling Builder.sizeBytes with sizeBytes.orElse(null).final CaseFile.BuildersizeBytes(JsonField<Long> sizeBytes)Sets Builder.sizeBytes to an arbitrary JSON value. final CaseFile.Builderstatus(FileStatus status)Lifecycle status of a case file: PENDING- An upload URL has been issued and the file is awaiting uploadREADY- The file has been uploaded and validated; a download URL is availableREJECTED- File validation failed; seefailure_reasonfor details
final CaseFile.Builderstatus(JsonField<FileStatus> status)Sets Builder.status to an arbitrary JSON value. final CaseFile.Builderupdated(OffsetDateTime updated)Date and time at which the file record was last updated final CaseFile.Builderupdated(JsonField<OffsetDateTime> updated)Sets Builder.updated to an arbitrary JSON value. final CaseFile.BuilderuploadConstraints(UploadConstraints uploadConstraints)Constraints applied to a file upload, returned alongside the upload URL so clients can validate before uploading final CaseFile.BuilderuploadConstraints(Optional<UploadConstraints> uploadConstraints)Alias for calling Builder.uploadConstraints with uploadConstraints.orElse(null).final CaseFile.BuilderuploadConstraints(JsonField<UploadConstraints> uploadConstraints)Sets Builder.uploadConstraints to an arbitrary JSON value. final CaseFile.BuilderuploadUrl(String uploadUrl)Presigned URL the client uses to upload the file final CaseFile.BuilderuploadUrl(Optional<String> uploadUrl)Alias for calling Builder.uploadUrl with uploadUrl.orElse(null).final CaseFile.BuilderuploadUrl(JsonField<String> uploadUrl)Sets Builder.uploadUrl to an arbitrary JSON value. final CaseFile.BuilderuploadUrlExpires(OffsetDateTime uploadUrlExpires)Date and time at which the upload URL expires final CaseFile.BuilderuploadUrlExpires(Optional<OffsetDateTime> uploadUrlExpires)Alias for calling Builder.uploadUrlExpires with uploadUrlExpires.orElse(null).final CaseFile.BuilderuploadUrlExpires(JsonField<OffsetDateTime> uploadUrlExpires)Sets Builder.uploadUrlExpires to an arbitrary JSON value. final CaseFile.BuilderadditionalProperties(Map<String, JsonValue> additionalProperties)final CaseFile.BuilderputAdditionalProperty(String key, JsonValue value)final CaseFile.BuilderputAllAdditionalProperties(Map<String, JsonValue> additionalProperties)final CaseFile.BuilderremoveAdditionalProperty(String key)final CaseFile.BuilderremoveAllAdditionalProperties(Set<String> keys)final CaseFilebuild()Returns an immutable instance of CaseFile. -
-
Method Detail
-
token
final CaseFile.Builder token(String token)
Globally unique identifier for the file
-
token
final CaseFile.Builder token(JsonField<String> token)
Sets Builder.token to an arbitrary JSON value.
You should usually call Builder.token with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
created
final CaseFile.Builder created(OffsetDateTime created)
Date and time at which the file record was created
-
created
final CaseFile.Builder created(JsonField<OffsetDateTime> created)
Sets Builder.created to an arbitrary JSON value.
You should usually call Builder.created with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
downloadUrl
final CaseFile.Builder downloadUrl(String downloadUrl)
Presigned URL the client uses to download the file
-
downloadUrl
final CaseFile.Builder downloadUrl(Optional<String> downloadUrl)
Alias for calling Builder.downloadUrl with
downloadUrl.orElse(null).
-
downloadUrl
final CaseFile.Builder downloadUrl(JsonField<String> downloadUrl)
Sets Builder.downloadUrl to an arbitrary JSON value.
You should usually call Builder.downloadUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
downloadUrlExpires
final CaseFile.Builder downloadUrlExpires(OffsetDateTime downloadUrlExpires)
Date and time at which the download URL expires
-
downloadUrlExpires
final CaseFile.Builder downloadUrlExpires(Optional<OffsetDateTime> downloadUrlExpires)
Alias for calling Builder.downloadUrlExpires with
downloadUrlExpires.orElse(null).
-
downloadUrlExpires
final CaseFile.Builder downloadUrlExpires(JsonField<OffsetDateTime> downloadUrlExpires)
Sets Builder.downloadUrlExpires to an arbitrary JSON value.
You should usually call Builder.downloadUrlExpires with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
failureReason
final CaseFile.Builder failureReason(String failureReason)
Reason the file was rejected, when applicable
-
failureReason
final CaseFile.Builder failureReason(Optional<String> failureReason)
Alias for calling Builder.failureReason with
failureReason.orElse(null).
-
failureReason
final CaseFile.Builder failureReason(JsonField<String> failureReason)
Sets Builder.failureReason to an arbitrary JSON value.
You should usually call Builder.failureReason 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 CaseFile.Builder mimeType(String mimeType)
MIME type of the file, available once the file is ready
-
mimeType
final CaseFile.Builder mimeType(Optional<String> mimeType)
Alias for calling Builder.mimeType with
mimeType.orElse(null).
-
mimeType
final CaseFile.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.
-
name
final CaseFile.Builder name(String name)
Name of the file
-
name
final CaseFile.Builder name(JsonField<String> name)
Sets Builder.name to an arbitrary JSON value.
You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
sizeBytes
final CaseFile.Builder sizeBytes(Long sizeBytes)
Size of the file in bytes, available once the file is ready
-
sizeBytes
final CaseFile.Builder sizeBytes(Long sizeBytes)
Alias for Builder.sizeBytes.
This unboxed primitive overload exists for backwards compatibility.
-
sizeBytes
final CaseFile.Builder sizeBytes(Optional<Long> sizeBytes)
Alias for calling Builder.sizeBytes with
sizeBytes.orElse(null).
-
sizeBytes
final CaseFile.Builder sizeBytes(JsonField<Long> sizeBytes)
Sets Builder.sizeBytes to an arbitrary JSON value.
You should usually call Builder.sizeBytes with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
status
final CaseFile.Builder status(FileStatus status)
Lifecycle status of a case file:
PENDING- An upload URL has been issued and the file is awaiting uploadREADY- The file has been uploaded and validated; a download URL is availableREJECTED- File validation failed; seefailure_reasonfor details
-
status
final CaseFile.Builder status(JsonField<FileStatus> status)
Sets Builder.status to an arbitrary JSON value.
You should usually call Builder.status with a well-typed FileStatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
updated
final CaseFile.Builder updated(OffsetDateTime updated)
Date and time at which the file record was last updated
-
updated
final CaseFile.Builder updated(JsonField<OffsetDateTime> updated)
Sets Builder.updated to an arbitrary JSON value.
You should usually call Builder.updated with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
uploadConstraints
final CaseFile.Builder uploadConstraints(UploadConstraints uploadConstraints)
Constraints applied to a file upload, returned alongside the upload URL so clients can validate before uploading
-
uploadConstraints
final CaseFile.Builder uploadConstraints(Optional<UploadConstraints> uploadConstraints)
Alias for calling Builder.uploadConstraints with
uploadConstraints.orElse(null).
-
uploadConstraints
final CaseFile.Builder uploadConstraints(JsonField<UploadConstraints> uploadConstraints)
Sets Builder.uploadConstraints to an arbitrary JSON value.
You should usually call Builder.uploadConstraints with a well-typed UploadConstraints value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
uploadUrl
final CaseFile.Builder uploadUrl(String uploadUrl)
Presigned URL the client uses to upload the file
-
uploadUrl
final CaseFile.Builder uploadUrl(Optional<String> uploadUrl)
Alias for calling Builder.uploadUrl with
uploadUrl.orElse(null).
-
uploadUrl
final CaseFile.Builder uploadUrl(JsonField<String> uploadUrl)
Sets Builder.uploadUrl to an arbitrary JSON value.
You should usually call Builder.uploadUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
uploadUrlExpires
final CaseFile.Builder uploadUrlExpires(OffsetDateTime uploadUrlExpires)
Date and time at which the upload URL expires
-
uploadUrlExpires
final CaseFile.Builder uploadUrlExpires(Optional<OffsetDateTime> uploadUrlExpires)
Alias for calling Builder.uploadUrlExpires with
uploadUrlExpires.orElse(null).
-
uploadUrlExpires
final CaseFile.Builder uploadUrlExpires(JsonField<OffsetDateTime> uploadUrlExpires)
Sets Builder.uploadUrlExpires to an arbitrary JSON value.
You should usually call Builder.uploadUrlExpires with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final CaseFile.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final CaseFile.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final CaseFile.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final CaseFile.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final CaseFile.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final CaseFile build()
Returns an immutable instance of CaseFile.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.token() .created() .downloadUrl() .downloadUrlExpires() .failureReason() .mimeType() .name() .sizeBytes() .status() .updated() .uploadConstraints() .uploadUrl() .uploadUrlExpires()
-
-
-