Class S3Object
- java.lang.Object
-
- software.amazon.awssdk.services.s3.model.S3Object
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<S3Object.Builder,S3Object>
@Generated("software.amazon.awssdk:codegen") public final class S3Object extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3Object.Builder,S3Object>
An object consists of data and its descriptive metadata.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
S3Object.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static S3Object.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 a hash 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()
String
key()
The name that you assign to an object.Instant
lastModified()
Creation date of the object.Owner
owner()
The owner of the objectRestoreStatus
restoreStatus()
Specifies the restoration status of an object.List<SdkField<?>>
sdkFields()
static Class<? extends S3Object.Builder>
serializableBuilderClass()
Long
size()
Size in bytes of the objectObjectStorageClass
storageClass()
The class of storage used to store the object.String
storageClassAsString()
The class of storage used to store the object.S3Object.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
-
key
public final String key()
The name that you assign to an object. You use the object key to retrieve the object.
- Returns:
- The name that you assign to an object. You use the object key to retrieve the object.
-
lastModified
public final Instant lastModified()
Creation date of the object.
- Returns:
- Creation date of the object.
-
eTag
public final String eTag()
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:
-
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
-
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
-
If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.
Directory buckets - MD5 is not supported by directory buckets.
- Returns:
- The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not
its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends
on how the object was created and how it is encrypted as described below:
-
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
-
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
-
If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.
Directory buckets - MD5 is not supported by directory buckets.
-
-
-
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 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.
-
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 ObjectStorageClass storageClass()
The class of storage used to store the object.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnObjectStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- The class of storage used to store the object.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- See Also:
ObjectStorageClass
-
storageClassAsString
public final String storageClassAsString()
The class of storage used to store the object.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnObjectStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- The class of storage used to store the object.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- See Also:
ObjectStorageClass
-
owner
public final Owner owner()
The owner of the object
Directory buckets - The bucket owner is returned as the object owner.
- Returns:
- The owner of the object
Directory buckets - The bucket owner is returned as the object owner.
-
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.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- 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.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
-
toBuilder
public S3Object.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<S3Object.Builder,S3Object>
-
builder
public static S3Object.Builder builder()
-
serializableBuilderClass
public static Class<? extends S3Object.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.
-
-