Class TransactionData

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.TransactionData
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransactionDataOrBuilder, Serializable

@Generated public final class TransactionData extends com.google.protobuf.GeneratedMessage implements TransactionDataOrBuilder
 Transaction data associated with a payment protected by reCAPTCHA Enterprise.
 
Protobuf type google.cloud.recaptchaenterprise.v1.TransactionData
See Also:
  • Field Details

    • TRANSACTION_ID_FIELD_NUMBER

      public static final int TRANSACTION_ID_FIELD_NUMBER
      See Also:
    • PAYMENT_METHOD_FIELD_NUMBER

      public static final int PAYMENT_METHOD_FIELD_NUMBER
      See Also:
    • CARD_BIN_FIELD_NUMBER

      public static final int CARD_BIN_FIELD_NUMBER
      See Also:
    • CARD_LAST_FOUR_FIELD_NUMBER

      public static final int CARD_LAST_FOUR_FIELD_NUMBER
      See Also:
    • CURRENCY_CODE_FIELD_NUMBER

      public static final int CURRENCY_CODE_FIELD_NUMBER
      See Also:
    • VALUE_FIELD_NUMBER

      public static final int VALUE_FIELD_NUMBER
      See Also:
    • SHIPPING_VALUE_FIELD_NUMBER

      public static final int SHIPPING_VALUE_FIELD_NUMBER
      See Also:
    • SHIPPING_ADDRESS_FIELD_NUMBER

      public static final int SHIPPING_ADDRESS_FIELD_NUMBER
      See Also:
    • BILLING_ADDRESS_FIELD_NUMBER

      public static final int BILLING_ADDRESS_FIELD_NUMBER
      See Also:
    • USER_FIELD_NUMBER

      public static final int USER_FIELD_NUMBER
      See Also:
    • MERCHANTS_FIELD_NUMBER

      public static final int MERCHANTS_FIELD_NUMBER
      See Also:
    • ITEMS_FIELD_NUMBER

      public static final int ITEMS_FIELD_NUMBER
      See Also:
    • GATEWAY_INFO_FIELD_NUMBER

      public static final int GATEWAY_INFO_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • hasTransactionId

      public boolean hasTransactionId()
       Unique identifier for the transaction. This custom identifier can be used
       to reference this transaction in the future, for example, labeling a refund
       or chargeback event. Two attempts at the same transaction should use the
       same transaction id.
       
      optional string transaction_id = 11;
      Specified by:
      hasTransactionId in interface TransactionDataOrBuilder
      Returns:
      Whether the transactionId field is set.
    • getTransactionId

      public String getTransactionId()
       Unique identifier for the transaction. This custom identifier can be used
       to reference this transaction in the future, for example, labeling a refund
       or chargeback event. Two attempts at the same transaction should use the
       same transaction id.
       
      optional string transaction_id = 11;
      Specified by:
      getTransactionId in interface TransactionDataOrBuilder
      Returns:
      The transactionId.
    • getTransactionIdBytes

      public com.google.protobuf.ByteString getTransactionIdBytes()
       Unique identifier for the transaction. This custom identifier can be used
       to reference this transaction in the future, for example, labeling a refund
       or chargeback event. Two attempts at the same transaction should use the
       same transaction id.
       
      optional string transaction_id = 11;
      Specified by:
      getTransactionIdBytes in interface TransactionDataOrBuilder
      Returns:
      The bytes for transactionId.
    • getPaymentMethod

      public String getPaymentMethod()
       Optional. The payment method for the transaction. The allowed values are:
      
       * credit-card
       * debit-card
       * gift-card
       * processor-{name} (If a third-party is used, for example,
       processor-paypal)
       * custom-{name} (If an alternative method is used, for example,
       custom-crypto)
       
      string payment_method = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPaymentMethod in interface TransactionDataOrBuilder
      Returns:
      The paymentMethod.
    • getPaymentMethodBytes

      public com.google.protobuf.ByteString getPaymentMethodBytes()
       Optional. The payment method for the transaction. The allowed values are:
      
       * credit-card
       * debit-card
       * gift-card
       * processor-{name} (If a third-party is used, for example,
       processor-paypal)
       * custom-{name} (If an alternative method is used, for example,
       custom-crypto)
       
      string payment_method = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPaymentMethodBytes in interface TransactionDataOrBuilder
      Returns:
      The bytes for paymentMethod.
    • getCardBin

      public String getCardBin()
       Optional. The Bank Identification Number - generally the first 6 or 8
       digits of the card.
       
      string card_bin = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCardBin in interface TransactionDataOrBuilder
      Returns:
      The cardBin.
    • getCardBinBytes

      public com.google.protobuf.ByteString getCardBinBytes()
       Optional. The Bank Identification Number - generally the first 6 or 8
       digits of the card.
       
      string card_bin = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCardBinBytes in interface TransactionDataOrBuilder
      Returns:
      The bytes for cardBin.
    • getCardLastFour

      public String getCardLastFour()
       Optional. The last four digits of the card.
       
      string card_last_four = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCardLastFour in interface TransactionDataOrBuilder
      Returns:
      The cardLastFour.
    • getCardLastFourBytes

      public com.google.protobuf.ByteString getCardLastFourBytes()
       Optional. The last four digits of the card.
       
      string card_last_four = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCardLastFourBytes in interface TransactionDataOrBuilder
      Returns:
      The bytes for cardLastFour.
    • getCurrencyCode

      public String getCurrencyCode()
       Optional. The currency code in ISO-4217 format.
       
      string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCurrencyCode in interface TransactionDataOrBuilder
      Returns:
      The currencyCode.
    • getCurrencyCodeBytes

      public com.google.protobuf.ByteString getCurrencyCodeBytes()
       Optional. The currency code in ISO-4217 format.
       
      string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCurrencyCodeBytes in interface TransactionDataOrBuilder
      Returns:
      The bytes for currencyCode.
    • getValue

      public double getValue()
       Optional. The decimal value of the transaction in the specified currency.
       
      double value = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getValue in interface TransactionDataOrBuilder
      Returns:
      The value.
    • getShippingValue

      public double getShippingValue()
       Optional. The value of shipping in the specified currency. 0 for free or no
       shipping.
       
      double shipping_value = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getShippingValue in interface TransactionDataOrBuilder
      Returns:
      The shippingValue.
    • hasShippingAddress

      public boolean hasShippingAddress()
       Optional. Destination address if this transaction involves shipping a
       physical item.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasShippingAddress in interface TransactionDataOrBuilder
      Returns:
      Whether the shippingAddress field is set.
    • getShippingAddress

      public TransactionData.Address getShippingAddress()
       Optional. Destination address if this transaction involves shipping a
       physical item.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getShippingAddress in interface TransactionDataOrBuilder
      Returns:
      The shippingAddress.
    • getShippingAddressOrBuilder

      public TransactionData.AddressOrBuilder getShippingAddressOrBuilder()
       Optional. Destination address if this transaction involves shipping a
       physical item.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getShippingAddressOrBuilder in interface TransactionDataOrBuilder
    • hasBillingAddress

      public boolean hasBillingAddress()
       Optional. Address associated with the payment method when applicable.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBillingAddress in interface TransactionDataOrBuilder
      Returns:
      Whether the billingAddress field is set.
    • getBillingAddress

      public TransactionData.Address getBillingAddress()
       Optional. Address associated with the payment method when applicable.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBillingAddress in interface TransactionDataOrBuilder
      Returns:
      The billingAddress.
    • getBillingAddressOrBuilder

      public TransactionData.AddressOrBuilder getBillingAddressOrBuilder()
       Optional. Address associated with the payment method when applicable.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBillingAddressOrBuilder in interface TransactionDataOrBuilder
    • hasUser

      public boolean hasUser()
       Optional. Information about the user paying/initiating the transaction.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasUser in interface TransactionDataOrBuilder
      Returns:
      Whether the user field is set.
    • getUser

      public TransactionData.User getUser()
       Optional. Information about the user paying/initiating the transaction.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUser in interface TransactionDataOrBuilder
      Returns:
      The user.
    • getUserOrBuilder

      public TransactionData.UserOrBuilder getUserOrBuilder()
       Optional. Information about the user paying/initiating the transaction.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserOrBuilder in interface TransactionDataOrBuilder
    • getMerchantsList

      public List<TransactionData.User> getMerchantsList()
       Optional. Information about the user or users fulfilling the transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMerchantsList in interface TransactionDataOrBuilder
    • getMerchantsOrBuilderList

      public List<? extends TransactionData.UserOrBuilder> getMerchantsOrBuilderList()
       Optional. Information about the user or users fulfilling the transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMerchantsOrBuilderList in interface TransactionDataOrBuilder
    • getMerchantsCount

      public int getMerchantsCount()
       Optional. Information about the user or users fulfilling the transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMerchantsCount in interface TransactionDataOrBuilder
    • getMerchants

      public TransactionData.User getMerchants(int index)
       Optional. Information about the user or users fulfilling the transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMerchants in interface TransactionDataOrBuilder
    • getMerchantsOrBuilder

      public TransactionData.UserOrBuilder getMerchantsOrBuilder(int index)
       Optional. Information about the user or users fulfilling the transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMerchantsOrBuilder in interface TransactionDataOrBuilder
    • getItemsList

      public List<TransactionData.Item> getItemsList()
       Optional. Items purchased in this transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getItemsList in interface TransactionDataOrBuilder
    • getItemsOrBuilderList

      public List<? extends TransactionData.ItemOrBuilder> getItemsOrBuilderList()
       Optional. Items purchased in this transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getItemsOrBuilderList in interface TransactionDataOrBuilder
    • getItemsCount

      public int getItemsCount()
       Optional. Items purchased in this transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getItemsCount in interface TransactionDataOrBuilder
    • getItems

      public TransactionData.Item getItems(int index)
       Optional. Items purchased in this transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getItems in interface TransactionDataOrBuilder
    • getItemsOrBuilder

      public TransactionData.ItemOrBuilder getItemsOrBuilder(int index)
       Optional. Items purchased in this transaction.
       
      repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getItemsOrBuilder in interface TransactionDataOrBuilder
    • hasGatewayInfo

      public boolean hasGatewayInfo()
       Optional. Information about the payment gateway's response to the
       transaction.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasGatewayInfo in interface TransactionDataOrBuilder
      Returns:
      Whether the gatewayInfo field is set.
    • getGatewayInfo

      public TransactionData.GatewayInfo getGatewayInfo()
       Optional. Information about the payment gateway's response to the
       transaction.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGatewayInfo in interface TransactionDataOrBuilder
      Returns:
      The gatewayInfo.
    • getGatewayInfoOrBuilder

      public TransactionData.GatewayInfoOrBuilder getGatewayInfoOrBuilder()
       Optional. Information about the payment gateway's response to the
       transaction.
       
      .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGatewayInfoOrBuilder in interface TransactionDataOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static TransactionData parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransactionData parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransactionData parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransactionData parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransactionData parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransactionData parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransactionData parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TransactionData parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static TransactionData parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static TransactionData parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TransactionData parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TransactionData parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public TransactionData.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static TransactionData.Builder newBuilder()
    • newBuilder

      public static TransactionData.Builder newBuilder(TransactionData prototype)
    • toBuilder

      public TransactionData.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected TransactionData.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static TransactionData getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<TransactionData> parser()
    • getParserForType

      public com.google.protobuf.Parser<TransactionData> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public TransactionData getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder