MacAttributes (AWS Java SDK :: Services :: Payment Cryptography Data 2.21.0 API)

java.lang.Object
- software.amazon.awssdk.services.paymentcryptographydata.model.MacAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MacAttributes.Builder,MacAttributes>
```
@Generated(value="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 and Description

static interface MacAttributes.Builder

static class MacAttributes.Type

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MacAttributes.Builder`
`static class`	`MacAttributes.Type`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MacAlgorithm`	`algorithm()` The encryption algorithm for MAC generation or verification.
`String`	`algorithmAsString()` The encryption algorithm for MAC generation or verification.
`static MacAttributes.Builder`	`builder()`
`MacAlgorithmDukpt`	`dukptCmac()` Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
`MacAlgorithmDukpt`	`dukptIso9797Algorithm1()` Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
`MacAlgorithmDukpt`	`dukptIso9797Algorithm3()` Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
`MacAlgorithmEmv`	`emvMac()` Parameters that are required for MAC generation or verification using EMV MAC algorithm.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`static MacAttributes`	`fromAlgorithm(MacAlgorithm algorithm)` Create an instance of this class with `algorithmAsString()` initialized to the given value.
`static MacAttributes`	`fromAlgorithm(String algorithm)` Create an instance of this class with `algorithmAsString()` initialized to the given value.
`static MacAttributes`	`fromDukptCmac(Consumer<MacAlgorithmDukpt.Builder> dukptCmac)` Create an instance of this class with `dukptCmac()` initialized to the given value.
`static MacAttributes`	`fromDukptCmac(MacAlgorithmDukpt dukptCmac)` Create an instance of this class with `dukptCmac()` initialized to the given value.
`static MacAttributes`	`fromDukptIso9797Algorithm1(Consumer<MacAlgorithmDukpt.Builder> dukptIso9797Algorithm1)` Create an instance of this class with `dukptIso9797Algorithm1()` initialized to the given value.
`static MacAttributes`	`fromDukptIso9797Algorithm1(MacAlgorithmDukpt dukptIso9797Algorithm1)` Create an instance of this class with `dukptIso9797Algorithm1()` initialized to the given value.
`static MacAttributes`	`fromDukptIso9797Algorithm3(Consumer<MacAlgorithmDukpt.Builder> dukptIso9797Algorithm3)` Create an instance of this class with `dukptIso9797Algorithm3()` initialized to the given value.
`static MacAttributes`	`fromDukptIso9797Algorithm3(MacAlgorithmDukpt dukptIso9797Algorithm3)` Create an instance of this class with `dukptIso9797Algorithm3()` initialized to the given value.
`static MacAttributes`	`fromEmvMac(Consumer<MacAlgorithmEmv.Builder> emvMac)` Create an instance of this class with `emvMac()` initialized to the given value.
`static MacAttributes`	`fromEmvMac(MacAlgorithmEmv emvMac)` Create an instance of this class with `emvMac()` initialized to the given value.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MacAttributes.Builder>`	`serializableBuilderClass()`
`MacAttributes.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`MacAttributes.Type`	`type()` 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, algorithm will return MacAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from algorithmAsString().
    
    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, algorithm will return MacAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from algorithmAsString().
    
    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 algorithm2.
    
    Returns:
    
    Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
  - 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:
    
    toBuilder in interface ToCopyableBuilder<MacAttributes.Builder,MacAttributes>
  - builder
```
public static MacAttributes.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MacAttributes.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)
```
  - fromAlgorithm
```
public static MacAttributes fromAlgorithm(String algorithm)
```
    Create an instance of this class with algorithmAsString() 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 with algorithmAsString() 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 with dukptCmac() 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 with dukptCmac() 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 with dukptIso9797Algorithm1() 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 with dukptIso9797Algorithm1() 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 with dukptIso9797Algorithm3() initialized to the given value.
    Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
    
    Parameters:
    
    dukptIso9797Algorithm3 - Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
  - fromDukptIso9797Algorithm3
```
public static MacAttributes fromDukptIso9797Algorithm3(Consumer<MacAlgorithmDukpt.Builder> dukptIso9797Algorithm3)
```
    Create an instance of this class with dukptIso9797Algorithm3() initialized to the given value.
    Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
    
    Parameters:
    
    dukptIso9797Algorithm3 - Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
  - fromEmvMac
```
public static MacAttributes fromEmvMac(MacAlgorithmEmv emvMac)
```
    Create an instance of this class with emvMac() 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 with emvMac() 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 be MacAttributes.Type.UNKNOWN_TO_SDK_VERSION if 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 be MacAttributes.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class MacAttributes

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

algorithm

algorithmAsString

dukptCmac

dukptIso9797Algorithm1

dukptIso9797Algorithm3

emvMac

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

fromAlgorithm

fromAlgorithm

fromDukptCmac

fromDukptCmac

fromDukptIso9797Algorithm1

fromDukptIso9797Algorithm1

fromDukptIso9797Algorithm3

fromDukptIso9797Algorithm3

fromEmvMac

fromEmvMac

type

sdkFields