Class TransactionData (3.28.0)

public final class TransactionData extends GeneratedMessageV3 implements TransactionDataOrBuilder

Transaction data associated with a payment protected by reCAPTCHA Enterprise.

Protobuf type google.cloud.recaptchaenterprise.v1.TransactionData

Static Fields

BILLING_ADDRESS_FIELD_NUMBER

public static final int BILLING_ADDRESS_FIELD_NUMBER
Field Value
TypeDescription
int

CARD_BIN_FIELD_NUMBER

public static final int CARD_BIN_FIELD_NUMBER
Field Value
TypeDescription
int

CARD_LAST_FOUR_FIELD_NUMBER

public static final int CARD_LAST_FOUR_FIELD_NUMBER
Field Value
TypeDescription
int

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

GATEWAY_INFO_FIELD_NUMBER

public static final int GATEWAY_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

ITEMS_FIELD_NUMBER

public static final int ITEMS_FIELD_NUMBER
Field Value
TypeDescription
int

MERCHANTS_FIELD_NUMBER

public static final int MERCHANTS_FIELD_NUMBER
Field Value
TypeDescription
int

PAYMENT_METHOD_FIELD_NUMBER

public static final int PAYMENT_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

SHIPPING_ADDRESS_FIELD_NUMBER

public static final int SHIPPING_ADDRESS_FIELD_NUMBER
Field Value
TypeDescription
int

SHIPPING_VALUE_FIELD_NUMBER

public static final int SHIPPING_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSACTION_ID_FIELD_NUMBER

public static final int TRANSACTION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

USER_FIELD_NUMBER

public static final int USER_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TransactionData getDefaultInstance()
Returns
TypeDescription
TransactionData

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransactionData.Builder newBuilder()
Returns
TypeDescription
TransactionData.Builder

newBuilder(TransactionData prototype)

public static TransactionData.Builder newBuilder(TransactionData prototype)
Parameter
NameDescription
prototypeTransactionData
Returns
TypeDescription
TransactionData.Builder

parseDelimitedFrom(InputStream input)

public static TransactionData parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionData parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransactionData parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransactionData parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransactionData parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransactionData parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransactionData parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionData parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransactionData parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionData parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransactionData parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransactionData parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionData
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TransactionData> parser()
Returns
TypeDescription
Parser<TransactionData>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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];

Returns
TypeDescription
TransactionData.Address

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];

Returns
TypeDescription
TransactionData.AddressOrBuilder

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];

Returns
TypeDescription
String

The cardBin.

getCardBinBytes()

public 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];

Returns
TypeDescription
ByteString

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];

Returns
TypeDescription
String

The cardLastFour.

getCardLastFourBytes()

public ByteString getCardLastFourBytes()

Optional. The last four digits of the card.

string card_last_four = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

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];

Returns
TypeDescription
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

Optional. The currency code in ISO-4217 format.

string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for currencyCode.

getDefaultInstanceForType()

public TransactionData getDefaultInstanceForType()
Returns
TypeDescription
TransactionData

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];

Returns
TypeDescription
TransactionData.GatewayInfo

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];

Returns
TypeDescription
TransactionData.GatewayInfoOrBuilder

getItems(int index)

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
TransactionData.Item

getItemsCount()

public int getItemsCount()

Optional. Items purchased in this transaction.

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

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];

Returns
TypeDescription
List<Item>

getItemsOrBuilder(int index)

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
TransactionData.ItemOrBuilder

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];

Returns
TypeDescription
List<? extends com.google.recaptchaenterprise.v1.TransactionData.ItemOrBuilder>

getMerchants(int index)

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
TransactionData.User

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];

Returns
TypeDescription
int

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];

Returns
TypeDescription
List<User>

getMerchantsOrBuilder(int index)

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
TransactionData.UserOrBuilder

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];

Returns
TypeDescription
List<? extends com.google.recaptchaenterprise.v1.TransactionData.UserOrBuilder>

getParserForType()

public Parser<TransactionData> getParserForType()
Returns
TypeDescription
Parser<TransactionData>
Overrides

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];

Returns
TypeDescription
String

The paymentMethod.

getPaymentMethodBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for paymentMethod.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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];

Returns
TypeDescription
TransactionData.Address

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];

Returns
TypeDescription
TransactionData.AddressOrBuilder

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];

Returns
TypeDescription
double

The shippingValue.

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;

Returns
TypeDescription
String

The transactionId.

getTransactionIdBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for transactionId.

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];

Returns
TypeDescription
TransactionData.User

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];

Returns
TypeDescription
TransactionData.UserOrBuilder

getValue()

public double getValue()

Optional. The decimal value of the transaction in the specified currency.

double value = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
double

The value.

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];

Returns
TypeDescription
boolean

Whether the billingAddress field is set.

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];

Returns
TypeDescription
boolean

Whether the gatewayInfo field is set.

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];

Returns
TypeDescription
boolean

Whether the shippingAddress field is set.

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;

Returns
TypeDescription
boolean

Whether the transactionId field is set.

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];

Returns
TypeDescription
boolean

Whether the user field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TransactionData.Builder newBuilderForType()
Returns
TypeDescription
TransactionData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransactionData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransactionData.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TransactionData.Builder toBuilder()
Returns
TypeDescription
TransactionData.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException