- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class TransactionInfo.Builder extends GeneratedMessageV3.Builder<TransactionInfo.Builder> implements TransactionInfoOrBuilder
A transaction represents the entire purchase transaction.
Protobuf type google.cloud.discoveryengine.v1.TransactionInfo
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransactionInfo.BuilderImplements
TransactionInfoOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransactionInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
build()
public TransactionInfo build()
Returns | |
---|---|
Type | Description |
TransactionInfo |
buildPartial()
public TransactionInfo buildPartial()
Returns | |
---|---|
Type | Description |
TransactionInfo |
clear()
public TransactionInfo.Builder clear()
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
clearCost()
public TransactionInfo.Builder clearCost()
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;
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
clearCurrency()
public TransactionInfo.Builder clearCurrency()
Required. Currency code. Use three-character ISO-4217 code.
string currency = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
clearDiscountValue()
public TransactionInfo.Builder clearDiscountValue()
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;
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public TransactionInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransactionInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
clearTax()
public TransactionInfo.Builder clearTax()
All the taxes associated with the transaction.
optional float tax = 4;
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
clearTransactionId()
public TransactionInfo.Builder clearTransactionId()
The transaction ID with a length limit of 128 characters.
string transaction_id = 3;
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
clearValue()
public TransactionInfo.Builder clearValue()
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];
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
clone()
public TransactionInfo.Builder clone()
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
getCost()
public float 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;
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for currency. |
getDefaultInstanceForType()
public TransactionInfo getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
TransactionInfo |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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;
Returns | |
---|---|
Type | Description |
float | The discountValue. |
getTax()
public float getTax()
All the taxes associated with the transaction.
optional float tax = 4;
Returns | |
---|---|
Type | Description |
float | The tax. |
getTransactionId()
public String getTransactionId()
The transaction ID with a length limit of 128 characters.
string transaction_id = 3;
Returns | |
---|---|
Type | Description |
String | The transactionId. |
getTransactionIdBytes()
public ByteString getTransactionIdBytes()
The transaction ID with a length limit of 128 characters.
string transaction_id = 3;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for transactionId. |
getValue()
public float 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];
Returns | |
---|---|
Type | Description |
float | The value. |
hasCost()
public boolean 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;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
boolean | Whether the discountValue field is set. |
hasTax()
public boolean hasTax()
All the taxes associated with the transaction.
optional float tax = 4;
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
boolean | Whether the value field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(TransactionInfo other)
public TransactionInfo.Builder mergeFrom(TransactionInfo other)
Parameter | |
---|---|
Name | Description |
other | TransactionInfo |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransactionInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public TransactionInfo.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransactionInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
setCost(float value)
public TransactionInfo.Builder setCost(float value)
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;
Parameter | |
---|---|
Name | Description |
value | float The cost to set. |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
setCurrency(String value)
public TransactionInfo.Builder setCurrency(String value)
Required. Currency code. Use three-character ISO-4217 code.
string currency = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | String The currency to set. |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
setCurrencyBytes(ByteString value)
public TransactionInfo.Builder setCurrencyBytes(ByteString value)
Required. Currency code. Use three-character ISO-4217 code.
string currency = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for currency to set. |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
setDiscountValue(float value)
public TransactionInfo.Builder setDiscountValue(float value)
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;
Parameter | |
---|---|
Name | Description |
value | float The discountValue to set. |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public TransactionInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TransactionInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
setTax(float value)
public TransactionInfo.Builder setTax(float value)
All the taxes associated with the transaction.
optional float tax = 4;
Parameter | |
---|---|
Name | Description |
value | float The tax to set. |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
setTransactionId(String value)
public TransactionInfo.Builder setTransactionId(String value)
The transaction ID with a length limit of 128 characters.
string transaction_id = 3;
Parameter | |
---|---|
Name | Description |
value | String The transactionId to set. |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
setTransactionIdBytes(ByteString value)
public TransactionInfo.Builder setTransactionIdBytes(ByteString value)
The transaction ID with a length limit of 128 characters.
string transaction_id = 3;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for transactionId to set. |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final TransactionInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder |
setValue(float value)
public TransactionInfo.Builder setValue(float value)
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];
Parameter | |
---|---|
Name | Description |
value | float The value to set. |
Returns | |
---|---|
Type | Description |
TransactionInfo.Builder | This builder for chaining. |