Class CaseFile
-
- All Implemented Interfaces:
public final class CaseFileA file attached to a case. Status-dependent fields are always present but may be
null:upload_url,upload_url_expires, andupload_constraintsare populated whenstatusisPENDINGorREJECTEDdownload_urlanddownload_url_expiresare populated whenstatusisREADYfailure_reasonis populated whenstatusisREJECTED
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCaseFile.BuilderA builder for CaseFile.
-
Method Summary
Modifier and Type Method Description final Stringtoken()Globally unique identifier for the file final OffsetDateTimecreated()Date and time at which the file record was created final Optional<String>downloadUrl()Presigned URL the client uses to download the file final Optional<OffsetDateTime>downloadUrlExpires()Date and time at which the download URL expires final Optional<String>failureReason()Reason the file was rejected, when applicable final Optional<String>mimeType()MIME type of the file, available once the file is ready final Stringname()Name of the file final Optional<Long>sizeBytes()Size of the file in bytes, available once the file is ready final FileStatusstatus()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 OffsetDateTimeupdated()Date and time at which the file record was last updated final Optional<UploadConstraints>uploadConstraints()Constraints applied to a file upload, returned alongside the upload URL so clients can validate before uploading final Optional<String>uploadUrl()Presigned URL the client uses to upload the file final Optional<OffsetDateTime>uploadUrlExpires()Date and time at which the upload URL expires final JsonField<String>_token()Returns the raw JSON value of token. final JsonField<OffsetDateTime>_created()Returns the raw JSON value of created. final JsonField<String>_downloadUrl()Returns the raw JSON value of downloadUrl. final JsonField<OffsetDateTime>_downloadUrlExpires()Returns the raw JSON value of downloadUrlExpires. final JsonField<String>_failureReason()Returns the raw JSON value of failureReason. final JsonField<String>_mimeType()Returns the raw JSON value of mimeType. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<Long>_sizeBytes()Returns the raw JSON value of sizeBytes. final JsonField<FileStatus>_status()Returns the raw JSON value of status. final JsonField<OffsetDateTime>_updated()Returns the raw JSON value of updated. final JsonField<UploadConstraints>_uploadConstraints()Returns the raw JSON value of uploadConstraints. final JsonField<String>_uploadUrl()Returns the raw JSON value of uploadUrl. final JsonField<OffsetDateTime>_uploadUrlExpires()Returns the raw JSON value of uploadUrlExpires. final Map<String, JsonValue>_additionalProperties()final CaseFile.BuildertoBuilder()final CaseFilevalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static CaseFile.Builderbuilder()Returns a mutable builder for constructing an instance of CaseFile. -
-
Method Detail
-
created
final OffsetDateTime created()
Date and time at which the file record was created
-
downloadUrl
final Optional<String> downloadUrl()
Presigned URL the client uses to download the file
-
downloadUrlExpires
final Optional<OffsetDateTime> downloadUrlExpires()
Date and time at which the download URL expires
-
failureReason
final Optional<String> failureReason()
Reason the file was rejected, when applicable
-
sizeBytes
final Optional<Long> sizeBytes()
Size of the file in bytes, available once the file is ready
-
status
final 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
-
updated
final OffsetDateTime updated()
Date and time at which the file record was last updated
-
uploadConstraints
final Optional<UploadConstraints> uploadConstraints()
Constraints applied to a file upload, returned alongside the upload URL so clients can validate before uploading
-
uploadUrlExpires
final Optional<OffsetDateTime> uploadUrlExpires()
Date and time at which the upload URL expires
-
_token
final JsonField<String> _token()
Returns the raw JSON value of token.
Unlike token, this method doesn't throw if the JSON field has an unexpected type.
-
_created
final JsonField<OffsetDateTime> _created()
Returns the raw JSON value of created.
Unlike created, this method doesn't throw if the JSON field has an unexpected type.
-
_downloadUrl
final JsonField<String> _downloadUrl()
Returns the raw JSON value of downloadUrl.
Unlike downloadUrl, this method doesn't throw if the JSON field has an unexpected type.
-
_downloadUrlExpires
final JsonField<OffsetDateTime> _downloadUrlExpires()
Returns the raw JSON value of downloadUrlExpires.
Unlike downloadUrlExpires, this method doesn't throw if the JSON field has an unexpected type.
-
_failureReason
final JsonField<String> _failureReason()
Returns the raw JSON value of failureReason.
Unlike failureReason, this method doesn't throw if the JSON field has an unexpected type.
-
_mimeType
final JsonField<String> _mimeType()
Returns the raw JSON value of mimeType.
Unlike mimeType, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_sizeBytes
final JsonField<Long> _sizeBytes()
Returns the raw JSON value of sizeBytes.
Unlike sizeBytes, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<FileStatus> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_updated
final JsonField<OffsetDateTime> _updated()
Returns the raw JSON value of updated.
Unlike updated, this method doesn't throw if the JSON field has an unexpected type.
-
_uploadConstraints
final JsonField<UploadConstraints> _uploadConstraints()
Returns the raw JSON value of uploadConstraints.
Unlike uploadConstraints, this method doesn't throw if the JSON field has an unexpected type.
-
_uploadUrl
final JsonField<String> _uploadUrl()
Returns the raw JSON value of uploadUrl.
Unlike uploadUrl, this method doesn't throw if the JSON field has an unexpected type.
-
_uploadUrlExpires
final JsonField<OffsetDateTime> _uploadUrlExpires()
Returns the raw JSON value of uploadUrlExpires.
Unlike uploadUrlExpires, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final CaseFile.Builder toBuilder()
-
validate
final CaseFile validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static CaseFile.Builder builder()
Returns a mutable builder for constructing an instance of CaseFile.
The following fields are required:
.token() .created() .downloadUrl() .downloadUrlExpires() .failureReason() .mimeType() .name() .sizeBytes() .status() .updated() .uploadConstraints() .uploadUrl() .uploadUrlExpires()
-
-
-