java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.paymentcryptographydata.model.PaymentCryptographyDataRequest
    - - software.amazon.awssdk.services.paymentcryptographydata.model.GeneratePinDataRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GeneratePinDataRequest.Builder,GeneratePinDataRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GeneratePinDataRequest
extends PaymentCryptographyDataRequest
implements ToCopyableBuilder<GeneratePinDataRequest.Builder,GeneratePinDataRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GeneratePinDataRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GeneratePinDataRequest.Builder`	`builder()`
`String`	`encryptionKeyIdentifier()`	The `keyARN` of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.
`WrappedKey`	`encryptionWrappedKey()`	Returns the value of the EncryptionWrappedKey property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`PinGenerationAttributes`	`generationAttributes()`	The attributes and values to use for PIN, PVV, or PIN Offset generation.
`String`	`generationKeyIdentifier()`	The `keyARN` of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`PinBlockFormatForPinData`	`pinBlockFormat()`	The PIN encoding format for pin data generation as specified in ISO 9564.
`String`	`pinBlockFormatAsString()`	The PIN encoding format for pin data generation as specified in ISO 9564.
`Integer`	`pinDataLength()`	The length of PIN under generation.
`String`	`primaryAccountNumber()`	The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GeneratePinDataRequest.Builder>`	`serializableBuilderClass()`
`GeneratePinDataRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - generationKeyIdentifier
```
public final String generationKeyIdentifier()
```
    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
    
    Returns:
    
    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
  - encryptionKeyIdentifier
```
public final String encryptionKeyIdentifier()
```
    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block. For ECDH, it is the keyARN of the asymmetric ECC key.
    
    Returns:
    
    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block. For ECDH, it is the keyARN of the asymmetric ECC key.
  - generationAttributes
```
public final PinGenerationAttributes generationAttributes()
```
    The attributes and values to use for PIN, PVV, or PIN Offset generation.
    
    Returns:
    
    The attributes and values to use for PIN, PVV, or PIN Offset generation.
  - pinDataLength
```
public final Integer pinDataLength()
```
    The length of PIN under generation.
    
    Returns:
    
    The length of PIN under generation.
  - primaryAccountNumber
```
public final String primaryAccountNumber()
```
    The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
    
    Returns:
    
    The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
  - pinBlockFormat
```
public final PinBlockFormatForPinData pinBlockFormat()
```
    The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
    
    The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
    
    The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
    
    If the service returns an enum value that is not available in the current SDK version, pinBlockFormat will return PinBlockFormatForPinData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pinBlockFormatAsString().
    
    Returns:
    
    The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
    
    The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
    
    The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
    
    See Also:
    
    PinBlockFormatForPinData
  - pinBlockFormatAsString
```
public final String pinBlockFormatAsString()
```
    The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
    
    The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
    
    The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
    
    If the service returns an enum value that is not available in the current SDK version, pinBlockFormat will return PinBlockFormatForPinData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pinBlockFormatAsString().
    
    Returns:
    
    The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
    
    The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
    
    The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
    
    See Also:
    
    PinBlockFormatForPinData
  - encryptionWrappedKey
```
public final WrappedKey encryptionWrappedKey()
```
    Returns the value of the EncryptionWrappedKey property for this object.
    
    Returns:
    
    The value of the EncryptionWrappedKey property for this object.
  - toBuilder
```
public GeneratePinDataRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GeneratePinDataRequest.Builder,GeneratePinDataRequest>
    
    Specified by:
    
    toBuilder in class PaymentCryptographyDataRequest
  - builder
```
public static GeneratePinDataRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GeneratePinDataRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GeneratePinDataRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

generationKeyIdentifier

encryptionKeyIdentifier

generationAttributes

pinDataLength

primaryAccountNumber

pinBlockFormat

pinBlockFormatAsString

encryptionWrappedKey

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField