Class DocumentVersionMetadata
- java.lang.Object
-
- software.amazon.awssdk.services.workdocs.model.DocumentVersionMetadata
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocumentVersionMetadata.Builder,DocumentVersionMetadata>
@Generated("software.amazon.awssdk:codegen") public final class DocumentVersionMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentVersionMetadata.Builder,DocumentVersionMetadata>
Describes a version of a document.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DocumentVersionMetadata.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DocumentVersionMetadata.Builder
builder()
Instant
contentCreatedTimestamp()
The timestamp when the content of the document was originally created.Instant
contentModifiedTimestamp()
The timestamp when the content of the document was modified.String
contentType()
The content type of the document.Instant
createdTimestamp()
The timestamp when the document was first uploaded.String
creatorId()
The ID of the creator.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasSource()
For responses, this returns true if the service returned a value for the Source property.boolean
hasThumbnail()
For responses, this returns true if the service returned a value for the Thumbnail property.String
id()
The ID of the version.Instant
modifiedTimestamp()
The timestamp when the document was last uploaded.String
name()
The name of the version.List<SdkField<?>>
sdkFields()
static Class<? extends DocumentVersionMetadata.Builder>
serializableBuilderClass()
String
signature()
The signature of the document.Long
size()
The size of the document, in bytes.Map<DocumentSourceType,String>
source()
The source of the document.Map<String,String>
sourceAsStrings()
The source of the document.DocumentStatusType
status()
The status of the document.String
statusAsString()
The status of the document.Map<DocumentThumbnailType,String>
thumbnail()
The thumbnail of the document.Map<String,String>
thumbnailAsStrings()
The thumbnail of the document.DocumentVersionMetadata.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
id
public final String id()
The ID of the version.
- Returns:
- The ID of the version.
-
name
public final String name()
The name of the version.
- Returns:
- The name of the version.
-
contentType
public final String contentType()
The content type of the document.
- Returns:
- The content type of the document.
-
size
public final Long size()
The size of the document, in bytes.
- Returns:
- The size of the document, in bytes.
-
signature
public final String signature()
The signature of the document.
- Returns:
- The signature of the document.
-
status
public final DocumentStatusType 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:
DocumentStatusType
-
statusAsString
public final String 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:
DocumentStatusType
-
createdTimestamp
public final Instant createdTimestamp()
The timestamp when the document was first uploaded.
- Returns:
- The timestamp when the document was first uploaded.
-
modifiedTimestamp
public final Instant modifiedTimestamp()
The timestamp when the document was last uploaded.
- Returns:
- The timestamp when the document was last uploaded.
-
contentCreatedTimestamp
public final Instant 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
public final Instant contentModifiedTimestamp()
The timestamp when the content of the document was modified.
- Returns:
- The timestamp when the content of the document was modified.
-
creatorId
public final String creatorId()
The ID of the creator.
- Returns:
- The ID of the creator.
-
thumbnail
public final Map<DocumentThumbnailType,String> 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
public final Map<String,String> 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
public final Map<DocumentSourceType,String> 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
public final Map<String,String> 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
public DocumentVersionMetadata.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DocumentVersionMetadata.Builder,DocumentVersionMetadata>
-
builder
public static DocumentVersionMetadata.Builder builder()
-
serializableBuilderClass
public static Class<? extends DocumentVersionMetadata.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-