Package software.amazon.awssdk.services.s3control.model

Class S3ObjectMetadata

java.lang.Object

software.amazon.awssdk.services.s3control.model.S3ObjectMetadata

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3ObjectMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static S3ObjectMetadata.Builder	builder()
String	cacheControl()
String	contentDisposition()
String	contentEncoding()
String	contentLanguage()
Long	contentLength()	This member has been deprecated.
String	contentMD5()	This member has been deprecated.
String	contentType()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUserMetadata()	For responses, this returns true if the service returned a value for the UserMetadata property.
Instant	httpExpiresDate()
Boolean	requesterCharged()	This member has been deprecated.
List<SdkField<?>>	sdkFields()
static Class<? extends S3ObjectMetadata.Builder>	serializableBuilderClass()
S3SSEAlgorithm	sseAlgorithm()
String	sseAlgorithmAsString()
S3ObjectMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Map<String,String>	userMetadata()

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

cacheControl

public final String cacheControl()

Returns:

contentDisposition

public final String contentDisposition()

Returns:

contentEncoding

public final String contentEncoding()

Returns:

contentLanguage

public final String contentLanguage()

Returns:

hasUserMetadata

public final boolean hasUserMetadata()

For responses, this returns true if the service returned a value for the UserMetadata 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.

userMetadata

public final Map<String,String> userMetadata()

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

Returns:

contentLength

public final Long contentLength()

This member has been deprecated.

Returns:

This member has been deprecated.

contentMD5

public final String contentMD5()

This member has been deprecated.

Returns:

This member has been deprecated.

contentType

public final String contentType()

Returns:

httpExpiresDate

public final Instant httpExpiresDate()

Returns:

requesterCharged

public final Boolean requesterCharged()

This member has been deprecated.

Returns:

This member has been deprecated.

sseAlgorithm

public final S3SSEAlgorithm sseAlgorithm()

For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

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

Returns:

For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) ( AES256) is supported.

See Also:

S3SSEAlgorithm

sseAlgorithmAsString

public final String sseAlgorithmAsString()

For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

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

Returns:

For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) ( AES256) is supported.

See Also:

S3SSEAlgorithm

toBuilder

public S3ObjectMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3ObjectMetadata.Builder,S3ObjectMetadata>

builder

public static S3ObjectMetadata.Builder builder()

serializableBuilderClass

public static Class<? extends S3ObjectMetadata.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