@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
S3Object.Builder |
Modifier and Type | Method and 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 object
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends S3Object.Builder> |
serializableBuilderClass() |
Long |
size()
Size in bytes of the object
|
ObjectStorageClass |
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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String key()
The name that you assign to an object. You use the object key to retrieve the object.
public final Instant lastModified()
Creation date of the object.
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.
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.
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.
public final boolean hasChecksumAlgorithm()
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.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.
public final Long size()
Size in bytes of the object
public final ObjectStorageClass 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 ObjectStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
ObjectStorageClass
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 ObjectStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
ObjectStorageClass
public final Owner owner()
The owner of the object
public S3Object.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<S3Object.Builder,S3Object>
public static S3Object.Builder builder()
public static Class<? extends S3Object.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.