Class DocumentVersionMetadata
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocumentVersionMetadata.Builder,
DocumentVersionMetadata>
Describes a version of a document.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The timestamp when the content of the document was originally created.final Instant
The timestamp when the content of the document was modified.final String
The content type of the document.final Instant
The timestamp when the document was first uploaded.final String
The ID of the creator.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Source property.final boolean
For responses, this returns true if the service returned a value for the Thumbnail property.final String
id()
The ID of the version.final Instant
The timestamp when the document was last uploaded.final String
name()
The name of the version.static Class
<? extends DocumentVersionMetadata.Builder> final String
The signature of the document.final Long
size()
The size of the document, in bytes.final Map
<DocumentSourceType, String> source()
The source of the document.The source of the document.final DocumentStatusType
status()
The status of the document.final String
The status of the document.final Map
<DocumentThumbnailType, String> The thumbnail of the document.The thumbnail of the document.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the version.
- Returns:
- The ID of the version.
-
name
The name of the version.
- Returns:
- The name of the version.
-
contentType
The content type of the document.
- Returns:
- The content type of the document.
-
size
The size of the document, in bytes.
- Returns:
- The size of the document, in bytes.
-
signature
The signature of the document.
- Returns:
- The signature of the document.
-
status
The status of the document.
If the service returns an enum value that is not available in the current SDK version,
status
will returnDocumentStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the document.
- See Also:
-
statusAsString
The status of the document.
If the service returns an enum value that is not available in the current SDK version,
status
will returnDocumentStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the document.
- See Also:
-
createdTimestamp
The timestamp when the document was first uploaded.
- Returns:
- The timestamp when the document was first uploaded.
-
modifiedTimestamp
The timestamp when the document was last uploaded.
- Returns:
- The timestamp when the document was last uploaded.
-
contentCreatedTimestamp
The timestamp when the content of the document was originally created.
- Returns:
- The timestamp when the content of the document was originally created.
-
contentModifiedTimestamp
The timestamp when the content of the document was modified.
- Returns:
- The timestamp when the content of the document was modified.
-
creatorId
The ID of the creator.
- Returns:
- The ID of the creator.
-
thumbnail
The thumbnail of the document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasThumbnail()
method.- Returns:
- The thumbnail of the document.
-
hasThumbnail
public final boolean hasThumbnail()For responses, this returns true if the service returned a value for the Thumbnail property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
thumbnailAsStrings
The thumbnail of the document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasThumbnail()
method.- Returns:
- The thumbnail of the document.
-
source
The source of the document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSource()
method.- Returns:
- The source of the document.
-
hasSource
public final boolean hasSource()For responses, this returns true if the service returned a value for the Source property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
sourceAsStrings
The source of the document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSource()
method.- Returns:
- The source of the document.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DocumentVersionMetadata.Builder,
DocumentVersionMetadata> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-