Class KeyBlockHeaders
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<KeyBlockHeaders.Builder,
KeyBlockHeaders>
Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic KeyBlockHeaders.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OptionalBlocks property.final KeyExportability
Specifies subsequent exportability of the key within the key block after it is received by the receiving party.final String
Specifies subsequent exportability of the key within the key block after it is received by the receiving party.final KeyModesOfUse
Returns the value of the KeyModesOfUse property for this object.final String
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.Parameter used to indicate the type of optional data in key block headers.static Class
<? extends KeyBlockHeaders.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
keyModesOfUse
Returns the value of the KeyModesOfUse property for this object.- Returns:
- The value of the KeyModesOfUse property for this object.
-
keyExportability
Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
When set to
EXPORTABLE
, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set toNON_EXPORTABLE
, the key cannot be subsequently exported by the receiver. When set toSENSITIVE
, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.If the service returns an enum value that is not available in the current SDK version,
keyExportability
will returnKeyExportability.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyExportabilityAsString()
.- Returns:
- Specifies subsequent exportability of the key within the key block after it is received by the receiving
party. It can be used to further restrict exportability of the key after export from Amazon Web Services
Payment Cryptography.
When set to
EXPORTABLE
, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set toNON_EXPORTABLE
, the key cannot be subsequently exported by the receiver. When set toSENSITIVE
, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022. - See Also:
-
keyExportabilityAsString
Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
When set to
EXPORTABLE
, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set toNON_EXPORTABLE
, the key cannot be subsequently exported by the receiver. When set toSENSITIVE
, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.If the service returns an enum value that is not available in the current SDK version,
keyExportability
will returnKeyExportability.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyExportabilityAsString()
.- Returns:
- Specifies subsequent exportability of the key within the key block after it is received by the receiving
party. It can be used to further restrict exportability of the key after export from Amazon Web Services
Payment Cryptography.
When set to
EXPORTABLE
, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set toNON_EXPORTABLE
, the key cannot be subsequently exported by the receiver. When set toSENSITIVE
, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022. - See Also:
-
keyVersion
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
- Returns:
- Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
-
hasOptionalBlocks
public final boolean hasOptionalBlocks()For responses, this returns true if the service returned a value for the OptionalBlocks 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. -
optionalBlocks
Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.
Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.
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
hasOptionalBlocks()
method.- Returns:
- Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on
allowed data type for optional blocks.
Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.
-
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 interfaceToCopyableBuilder<KeyBlockHeaders.Builder,
KeyBlockHeaders> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-