public final class TransactionInfo extends GeneratedMessageV3 implements TransactionInfoOrBuilder
A transaction represents the entire purchase transaction.
Protobuf type google.cloud.discoveryengine.v1beta.TransactionInfo
Static Fields
COST_FIELD_NUMBER
public static final int COST_FIELD_NUMBER
Field Value
CURRENCY_FIELD_NUMBER
public static final int CURRENCY_FIELD_NUMBER
Field Value
DISCOUNT_VALUE_FIELD_NUMBER
public static final int DISCOUNT_VALUE_FIELD_NUMBER
Field Value
TAX_FIELD_NUMBER
public static final int TAX_FIELD_NUMBER
Field Value
TRANSACTION_ID_FIELD_NUMBER
public static final int TRANSACTION_ID_FIELD_NUMBER
Field Value
VALUE_FIELD_NUMBER
public static final int VALUE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TransactionInfo getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TransactionInfo.Builder newBuilder()
Returns
newBuilder(TransactionInfo prototype)
public static TransactionInfo.Builder newBuilder(TransactionInfo prototype)
Parameter
Returns
public static TransactionInfo parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransactionInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TransactionInfo parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransactionInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TransactionInfo parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransactionInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransactionInfo parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TransactionInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransactionInfo parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransactionInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TransactionInfo parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransactionInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TransactionInfo> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCost()
All the costs associated with the products. These can be manufacturing
costs, shipping expenses not borne by the end user, or any other costs,
such that:
- Profit =
value -
tax -
cost
optional float cost = 5;
| Type | Description |
float | The cost.
|
getCurrency()
public String getCurrency()
Required. Currency code. Use three-character ISO-4217 code.
string currency = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
String | The currency.
|
getCurrencyBytes()
public ByteString getCurrencyBytes()
Required. Currency code. Use three-character ISO-4217 code.
string currency = 2 [(.google.api.field_behavior) = REQUIRED];
getDefaultInstanceForType()
public TransactionInfo getDefaultInstanceForType()
Returns
getDiscountValue()
public float getDiscountValue()
The total discount(s) value applied to this transaction.
This figure should be excluded from
TransactionInfo.value
For example, if a user paid
TransactionInfo.value
amount, then nominal (pre-discount) value of the transaction is the sum of
TransactionInfo.value
and
TransactionInfo.discount_value
This means that profit is calculated the same way, regardless of the
discount value, and that
TransactionInfo.discount_value
can be larger than
TransactionInfo.value:
- Profit =
value -
tax -
cost
optional float discount_value = 6;
| Type | Description |
float | The discountValue.
|
getParserForType()
public Parser<TransactionInfo> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTax()
All the taxes associated with the transaction.
optional float tax = 4;
| Type | Description |
float | The tax.
|
getTransactionId()
public String getTransactionId()
The transaction ID with a length limit of 128 characters.
string transaction_id = 3;
| Type | Description |
String | The transactionId.
|
getTransactionIdBytes()
public ByteString getTransactionIdBytes()
The transaction ID with a length limit of 128 characters.
string transaction_id = 3;
| Type | Description |
ByteString | The bytes for transactionId.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getValue()
Required. Total non-zero value associated with the transaction. This value
may include shipping, tax, or other adjustments to the total value that you
want to include.
optional float value = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
float | The value.
|
hasCost()
All the costs associated with the products. These can be manufacturing
costs, shipping expenses not borne by the end user, or any other costs,
such that:
- Profit =
value -
tax -
cost
optional float cost = 5;
| Type | Description |
boolean | Whether the cost field is set.
|
hasDiscountValue()
public boolean hasDiscountValue()
The total discount(s) value applied to this transaction.
This figure should be excluded from
TransactionInfo.value
For example, if a user paid
TransactionInfo.value
amount, then nominal (pre-discount) value of the transaction is the sum of
TransactionInfo.value
and
TransactionInfo.discount_value
This means that profit is calculated the same way, regardless of the
discount value, and that
TransactionInfo.discount_value
can be larger than
TransactionInfo.value:
- Profit =
value -
tax -
cost
optional float discount_value = 6;
| Type | Description |
boolean | Whether the discountValue field is set.
|
hasTax()
All the taxes associated with the transaction.
optional float tax = 4;
| Type | Description |
boolean | Whether the tax field is set.
|
hasValue()
public boolean hasValue()
Required. Total non-zero value associated with the transaction. This value
may include shipping, tax, or other adjustments to the total value that you
want to include.
optional float value = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
boolean | Whether the value field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TransactionInfo.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransactionInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TransactionInfo.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
