software.amazon.awssdk.services.glacier.model

Class Encryption

java.lang.Object

software.amazon.awssdk.services.glacier.model.Encryption

All Implemented Interfaces:

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

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

Contains information about the encryption used to store the job results in Amazon S3.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Encryption.Builder

Method Summary

Modifier and Type	Method and Description
static Encryption.Builder	builder()
EncryptionType	encryptionType() The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.
String	encryptionTypeAsString() The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsContext() Optional.
String	kmsKeyId() The AWS KMS key ID to use for object encryption.
List<SdkField<?>>	sdkFields()
static Class<? extends Encryption.Builder>	serializableBuilderClass()
Encryption.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

encryptionType

public EncryptionType encryptionType()

The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.

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

Returns:

The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.

See Also:

EncryptionType

encryptionTypeAsString

public String encryptionTypeAsString()

The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.

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

Returns:

The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.

See Also:

EncryptionType

kmsKeyId

public String kmsKeyId()

The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or Signature Version 4.

Returns:

The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or Signature Version 4.

kmsContext

public String kmsContext()

Optional. If the encryption type is aws:kms, you can use this value to specify the encryption context for the job results.

Returns:

Optional. If the encryption type is aws:kms, you can use this value to specify the encryption context for the job results.

toBuilder

public Encryption.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Encryption.Builder,Encryption>

Returns:

a builder for type T

builder

public static Encryption.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.