Interface GeneratePinDataRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GeneratePinDataRequest.Builder,GeneratePinDataRequest>, PaymentCryptographyDataRequest.Builder, SdkBuilder<GeneratePinDataRequest.Builder,GeneratePinDataRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GeneratePinDataRequest
@Mutable @NotThreadSafe public static interface GeneratePinDataRequest.Builder extends PaymentCryptographyDataRequest.Builder, SdkPojo, CopyableBuilder<GeneratePinDataRequest.Builder,GeneratePinDataRequest>

  • Method Details

    • generationKeyIdentifier

      GeneratePinDataRequest.Builder generationKeyIdentifier(String generationKeyIdentifier)

      The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.

      Parameters:
      generationKeyIdentifier - The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionKeyIdentifier

      GeneratePinDataRequest.Builder encryptionKeyIdentifier(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • generationAttributes

      GeneratePinDataRequest.Builder generationAttributes(PinGenerationAttributes generationAttributes)

      The attributes and values to use for PIN, PVV, or PIN Offset generation.

      Parameters:
      generationAttributes - The attributes and values to use for PIN, PVV, or PIN Offset generation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • generationAttributes

      default GeneratePinDataRequest.Builder generationAttributes(Consumer<PinGenerationAttributes.Builder> generationAttributes)

      The attributes and values to use for PIN, PVV, or PIN Offset generation.

      This is a convenience method that creates an instance of the PinGenerationAttributes.Builder avoiding the need to create one manually via PinGenerationAttributes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to generationAttributes(PinGenerationAttributes).

      Parameters:
      generationAttributes - a consumer that will call methods on PinGenerationAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pinDataLength

      GeneratePinDataRequest.Builder pinDataLength(Integer pinDataLength)

      The length of PIN under generation.

      Parameters:
      pinDataLength - The length of PIN under generation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • primaryAccountNumber

      GeneratePinDataRequest.Builder primaryAccountNumber(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • pinBlockFormat

      GeneratePinDataRequest.Builder pinBlockFormat(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pinBlockFormat

      GeneratePinDataRequest.Builder pinBlockFormat(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionWrappedKey

      GeneratePinDataRequest.Builder encryptionWrappedKey(WrappedKey encryptionWrappedKey)
      Sets the value of the EncryptionWrappedKey property for this object.
      Parameters:
      encryptionWrappedKey - The new value for the EncryptionWrappedKey property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionWrappedKey

      default GeneratePinDataRequest.Builder encryptionWrappedKey(Consumer<WrappedKey.Builder> encryptionWrappedKey)
      Sets the value of the EncryptionWrappedKey property for this object. This is a convenience method that creates an instance of the WrappedKey.Builder avoiding the need to create one manually via WrappedKey.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionWrappedKey(WrappedKey).

      Parameters:
      encryptionWrappedKey - a consumer that will call methods on WrappedKey.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      GeneratePinDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GeneratePinDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.