Package software.amazon.awssdk.services.accessanalyzer.model

Class KmsGrantConstraints

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.KmsGrantConstraints

All Implemented Interfaces:

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

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

Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context. You can specify only one type of encryption context. An empty map is treated as not specified. For more information, see GrantConstraints.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KmsGrantConstraints.Builder

Method Summary

Modifier and Type	Method	Description
static KmsGrantConstraints.Builder	builder()
Map<String,String>	encryptionContextEquals()	A list of key-value pairs that must match the encryption context in the cryptographic operation request.
Map<String,String>	encryptionContextSubset()	A list of key-value pairs that must be included in the encryption context of the cryptographic operation request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEncryptionContextEquals()	For responses, this returns true if the service returned a value for the EncryptionContextEquals property.
boolean	hasEncryptionContextSubset()	For responses, this returns true if the service returned a value for the EncryptionContextSubset property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends KmsGrantConstraints.Builder>	serializableBuilderClass()
KmsGrantConstraints.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

hasEncryptionContextEquals

public final boolean hasEncryptionContextEquals()

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

encryptionContextEquals

public final Map<String,String> encryptionContextEquals()

A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

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

Returns:

A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

hasEncryptionContextSubset

public final boolean hasEncryptionContextSubset()

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

encryptionContextSubset

public final Map<String,String> encryptionContextSubset()

A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

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

Returns:

A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

toBuilder

public KmsGrantConstraints.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KmsGrantConstraints.Builder,KmsGrantConstraints>

builder

public static KmsGrantConstraints.Builder builder()

serializableBuilderClass

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