Package software.amazon.awssdk.services.s3.model

Class ObjectVersion

java.lang.Object

software.amazon.awssdk.services.s3.model.ObjectVersion

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ObjectVersion.Builder,ObjectVersion>

@Generated("software.amazon.awssdk:codegen")
public final class ObjectVersion
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ObjectVersion.Builder,ObjectVersion>

The version of an object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ObjectVersion.Builder

Method Summary

Modifier and Type	Method	Description
static ObjectVersion.Builder	builder()
List<ChecksumAlgorithm>	checksumAlgorithm()	The algorithm that was used to create a checksum of the object.
List<String>	checksumAlgorithmAsStrings()	The algorithm that was used to create a checksum of the object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eTag()	The entity tag is an MD5 hash of that version of the object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChecksumAlgorithm()	For responses, this returns true if the service returned a value for the ChecksumAlgorithm property.
int	hashCode()
Boolean	isLatest()	Specifies whether the object is (true) or is not (false) the latest version of an object.
String	key()	The object key.
Instant	lastModified()	Date and time when the object was last modified.
Owner	owner()	Specifies the owner of the object.
RestoreStatus	restoreStatus()	Specifies the restoration status of an object.
List<SdkField<?>>	sdkFields()
static Class<? extends ObjectVersion.Builder>	serializableBuilderClass()
Long	size()	Size in bytes of the object.
ObjectVersionStorageClass	storageClass()	The class of storage used to store the object.
String	storageClassAsString()	The class of storage used to store the object.
ObjectVersion.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionId()	Version ID of an 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

eTag

public final String eTag()

The entity tag is an MD5 hash of that version of the object.

Returns:

The entity tag is an MD5 hash of that version of the object.

checksumAlgorithm

public final List<ChecksumAlgorithm> checksumAlgorithm()

The algorithm that was used to create a checksum of the object.

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 hasChecksumAlgorithm() method.

Returns:

The algorithm that was used to create a checksum of the object.

hasChecksumAlgorithm

public final boolean hasChecksumAlgorithm()

For responses, this returns true if the service returned a value for the ChecksumAlgorithm property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

checksumAlgorithmAsStrings

public final List<String> checksumAlgorithmAsStrings()

The algorithm that was used to create a checksum of the object.

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 hasChecksumAlgorithm() method.

Returns:

The algorithm that was used to create a checksum of the object.

size

public final Long size()

Size in bytes of the object.

Returns:

Size in bytes of the object.

storageClass

public final ObjectVersionStorageClass storageClass()

The class of storage used to store the object.

If the service returns an enum value that is not available in the current SDK version, storageClass will return ObjectVersionStorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

Returns:

The class of storage used to store the object.

See Also:

ObjectVersionStorageClass

storageClassAsString

public final String storageClassAsString()

The class of storage used to store the object.

If the service returns an enum value that is not available in the current SDK version, storageClass will return ObjectVersionStorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

Returns:

The class of storage used to store the object.

See Also:

ObjectVersionStorageClass

key

public final String key()

The object key.

Returns:

The object key.

versionId

public final String versionId()

Version ID of an object.

Returns:

Version ID of an object.

isLatest

public final Boolean isLatest()

Specifies whether the object is (true) or is not (false) the latest version of an object.

Returns:

Specifies whether the object is (true) or is not (false) the latest version of an object.

lastModified

public final Instant lastModified()

Date and time when the object was last modified.

Returns:

Date and time when the object was last modified.

owner

public final Owner owner()

Specifies the owner of the object.

Returns:

Specifies the owner of the object.

restoreStatus

public final RestoreStatus restoreStatus()

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

Returns:

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

toBuilder

public ObjectVersion.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ObjectVersion.Builder,ObjectVersion>

builder

public static ObjectVersion.Builder builder()

serializableBuilderClass

public static Class<? extends ObjectVersion.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo