Class MacAttributes
- java.lang.Object
-
- software.amazon.awssdk.services.paymentcryptographydata.model.MacAttributes
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<MacAttributes.Builder,MacAttributes>
@Generated("software.amazon.awssdk:codegen") public final class MacAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MacAttributes.Builder,MacAttributes>
Parameters that are required for DUKPT, HMAC, or EMV MAC generation or verification.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceMacAttributes.Builderstatic classMacAttributes.Type
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MacAlgorithmalgorithm()The encryption algorithm for MAC generation or verification.StringalgorithmAsString()The encryption algorithm for MAC generation or verification.static MacAttributes.Builderbuilder()MacAlgorithmDukptdukptCmac()Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.MacAlgorithmDukptdukptIso9797Algorithm1()Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.MacAlgorithmDukptdukptIso9797Algorithm3()Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.MacAlgorithmEmvemvMac()Parameters that are required for MAC generation or verification using EMV MAC algorithm.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)static MacAttributesfromAlgorithm(String algorithm)Create an instance of this class withalgorithmAsString()initialized to the given value.static MacAttributesfromAlgorithm(MacAlgorithm algorithm)Create an instance of this class withalgorithmAsString()initialized to the given value.static MacAttributesfromDukptCmac(Consumer<MacAlgorithmDukpt.Builder> dukptCmac)Create an instance of this class withdukptCmac()initialized to the given value.static MacAttributesfromDukptCmac(MacAlgorithmDukpt dukptCmac)Create an instance of this class withdukptCmac()initialized to the given value.static MacAttributesfromDukptIso9797Algorithm1(Consumer<MacAlgorithmDukpt.Builder> dukptIso9797Algorithm1)Create an instance of this class withdukptIso9797Algorithm1()initialized to the given value.static MacAttributesfromDukptIso9797Algorithm1(MacAlgorithmDukpt dukptIso9797Algorithm1)Create an instance of this class withdukptIso9797Algorithm1()initialized to the given value.static MacAttributesfromDukptIso9797Algorithm3(Consumer<MacAlgorithmDukpt.Builder> dukptIso9797Algorithm3)Create an instance of this class withdukptIso9797Algorithm3()initialized to the given value.static MacAttributesfromDukptIso9797Algorithm3(MacAlgorithmDukpt dukptIso9797Algorithm3)Create an instance of this class withdukptIso9797Algorithm3()initialized to the given value.static MacAttributesfromEmvMac(Consumer<MacAlgorithmEmv.Builder> emvMac)Create an instance of this class withemvMac()initialized to the given value.static MacAttributesfromEmvMac(MacAlgorithmEmv emvMac)Create an instance of this class withemvMac()initialized to the given value.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()List<SdkField<?>>sdkFields()static Class<? extends MacAttributes.Builder>serializableBuilderClass()MacAttributes.BuildertoBuilder()StringtoString()Returns a string representation of this object.MacAttributes.Typetype()Retrieve an enum value representing which member of this object is populated.-
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
-
algorithm
public final MacAlgorithm algorithm()
The encryption algorithm for MAC generation or verification.
If the service returns an enum value that is not available in the current SDK version,
algorithmwill returnMacAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromalgorithmAsString().- Returns:
- The encryption algorithm for MAC generation or verification.
- See Also:
MacAlgorithm
-
algorithmAsString
public final String algorithmAsString()
The encryption algorithm for MAC generation or verification.
If the service returns an enum value that is not available in the current SDK version,
algorithmwill returnMacAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromalgorithmAsString().- Returns:
- The encryption algorithm for MAC generation or verification.
- See Also:
MacAlgorithm
-
dukptCmac
public final MacAlgorithmDukpt dukptCmac()
Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
- Returns:
- Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
-
dukptIso9797Algorithm1
public final MacAlgorithmDukpt dukptIso9797Algorithm1()
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
- Returns:
- Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
-
dukptIso9797Algorithm3
public final MacAlgorithmDukpt dukptIso9797Algorithm3()
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
- Returns:
- Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
-
emvMac
public final MacAlgorithmEmv emvMac()
Parameters that are required for MAC generation or verification using EMV MAC algorithm.
- Returns:
- Parameters that are required for MAC generation or verification using EMV MAC algorithm.
-
toBuilder
public MacAttributes.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<MacAttributes.Builder,MacAttributes>
-
builder
public static MacAttributes.Builder builder()
-
serializableBuilderClass
public static Class<? extends MacAttributes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
fromAlgorithm
public static MacAttributes fromAlgorithm(String algorithm)
Create an instance of this class withalgorithmAsString()initialized to the given value.The encryption algorithm for MAC generation or verification.
- Parameters:
algorithm- The encryption algorithm for MAC generation or verification.- See Also:
MacAlgorithm
-
fromAlgorithm
public static MacAttributes fromAlgorithm(MacAlgorithm algorithm)
Create an instance of this class withalgorithmAsString()initialized to the given value.The encryption algorithm for MAC generation or verification.
- Parameters:
algorithm- The encryption algorithm for MAC generation or verification.- See Also:
MacAlgorithm
-
fromDukptCmac
public static MacAttributes fromDukptCmac(MacAlgorithmDukpt dukptCmac)
Create an instance of this class withdukptCmac()initialized to the given value.Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
- Parameters:
dukptCmac- Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
-
fromDukptCmac
public static MacAttributes fromDukptCmac(Consumer<MacAlgorithmDukpt.Builder> dukptCmac)
Create an instance of this class withdukptCmac()initialized to the given value.Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
- Parameters:
dukptCmac- Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
-
fromDukptIso9797Algorithm1
public static MacAttributes fromDukptIso9797Algorithm1(MacAlgorithmDukpt dukptIso9797Algorithm1)
Create an instance of this class withdukptIso9797Algorithm1()initialized to the given value.Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
- Parameters:
dukptIso9797Algorithm1- Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
-
fromDukptIso9797Algorithm1
public static MacAttributes fromDukptIso9797Algorithm1(Consumer<MacAlgorithmDukpt.Builder> dukptIso9797Algorithm1)
Create an instance of this class withdukptIso9797Algorithm1()initialized to the given value.Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
- Parameters:
dukptIso9797Algorithm1- Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
-
fromDukptIso9797Algorithm3
public static MacAttributes fromDukptIso9797Algorithm3(MacAlgorithmDukpt dukptIso9797Algorithm3)
Create an instance of this class withdukptIso9797Algorithm3()initialized to the given value.Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
- Parameters:
dukptIso9797Algorithm3- Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
-
fromDukptIso9797Algorithm3
public static MacAttributes fromDukptIso9797Algorithm3(Consumer<MacAlgorithmDukpt.Builder> dukptIso9797Algorithm3)
Create an instance of this class withdukptIso9797Algorithm3()initialized to the given value.Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
- Parameters:
dukptIso9797Algorithm3- Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
-
fromEmvMac
public static MacAttributes fromEmvMac(MacAlgorithmEmv emvMac)
Create an instance of this class withemvMac()initialized to the given value.Parameters that are required for MAC generation or verification using EMV MAC algorithm.
- Parameters:
emvMac- Parameters that are required for MAC generation or verification using EMV MAC algorithm.
-
fromEmvMac
public static MacAttributes fromEmvMac(Consumer<MacAlgorithmEmv.Builder> emvMac)
Create an instance of this class withemvMac()initialized to the given value.Parameters that are required for MAC generation or verification using EMV MAC algorithm.
- Parameters:
emvMac- Parameters that are required for MAC generation or verification using EMV MAC algorithm.
-
type
public MacAttributes.Type type()
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beMacAttributes.Type.UNKNOWN_TO_SDK_VERSIONif the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beMacAttributes.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set.
-
-