public final class PurchaseTransaction extends GeneratedMessageV3 implements PurchaseTransactionOrBuilder
A transaction represents the entire purchase transaction.
Protobuf type google.cloud.recommendationengine.v1beta1.PurchaseTransaction
Static Fields
COSTS_FIELD_NUMBER
public static final int COSTS_FIELD_NUMBER
Field Value
CURRENCY_CODE_FIELD_NUMBER
public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
REVENUE_FIELD_NUMBER
public static final int REVENUE_FIELD_NUMBER
Field Value
TAXES_FIELD_NUMBER
public static final int TAXES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PurchaseTransaction getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PurchaseTransaction.Builder newBuilder()
Returns
newBuilder(PurchaseTransaction prototype)
public static PurchaseTransaction.Builder newBuilder(PurchaseTransaction prototype)
Parameter
Returns
public static PurchaseTransaction parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PurchaseTransaction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PurchaseTransaction parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PurchaseTransaction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PurchaseTransaction parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurchaseTransaction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PurchaseTransaction parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PurchaseTransaction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PurchaseTransaction parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PurchaseTransaction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PurchaseTransaction parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PurchaseTransaction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PurchaseTransaction> parser()
Returns
Methods
containsCosts(String key)
public boolean containsCosts(String key)
Optional. All the costs associated with the product. These can be
manufacturing costs, shipping expenses not borne by the end user, or any
other costs.
Total product cost such that
profit = revenue - (sum(taxes) + sum(costs))
If product_cost is not set, then
profit = revenue - tax - shipping - sum(CatalogItem.costs).
If CatalogItem.cost is not specified for one of the items, CatalogItem.cost
based profit cannot be calculated for this Transaction.
map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];
containsTaxes(String key)
public boolean containsTaxes(String key)
Optional. All the taxes associated with the transaction.
map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCosts()
public Map<String,Float> getCosts()
Returns
getCostsCount()
public int getCostsCount()
Optional. All the costs associated with the product. These can be
manufacturing costs, shipping expenses not borne by the end user, or any
other costs.
Total product cost such that
profit = revenue - (sum(taxes) + sum(costs))
If product_cost is not set, then
profit = revenue - tax - shipping - sum(CatalogItem.costs).
If CatalogItem.cost is not specified for one of the items, CatalogItem.cost
based profit cannot be calculated for this Transaction.
map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];
getCostsMap()
public Map<String,Float> getCostsMap()
Optional. All the costs associated with the product. These can be
manufacturing costs, shipping expenses not borne by the end user, or any
other costs.
Total product cost such that
profit = revenue - (sum(taxes) + sum(costs))
If product_cost is not set, then
profit = revenue - tax - shipping - sum(CatalogItem.costs).
If CatalogItem.cost is not specified for one of the items, CatalogItem.cost
based profit cannot be calculated for this Transaction.
map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];
getCostsOrDefault(String key, float defaultValue)
public float getCostsOrDefault(String key, float defaultValue)
Optional. All the costs associated with the product. These can be
manufacturing costs, shipping expenses not borne by the end user, or any
other costs.
Total product cost such that
profit = revenue - (sum(taxes) + sum(costs))
If product_cost is not set, then
profit = revenue - tax - shipping - sum(CatalogItem.costs).
If CatalogItem.cost is not specified for one of the items, CatalogItem.cost
based profit cannot be calculated for this Transaction.
map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];
getCostsOrThrow(String key)
public float getCostsOrThrow(String key)
Optional. All the costs associated with the product. These can be
manufacturing costs, shipping expenses not borne by the end user, or any
other costs.
Total product cost such that
profit = revenue - (sum(taxes) + sum(costs))
If product_cost is not set, then
profit = revenue - tax - shipping - sum(CatalogItem.costs).
If CatalogItem.cost is not specified for one of the items, CatalogItem.cost
based profit cannot be calculated for this Transaction.
map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];
getCurrencyCode()
public String getCurrencyCode()
Required. Currency code. Use three-character ISO-4217 code. This field
is not required if the event type is refund.
string currency_code = 6 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The currencyCode.
|
getCurrencyCodeBytes()
public ByteString getCurrencyCodeBytes()
Required. Currency code. Use three-character ISO-4217 code. This field
is not required if the event type is refund.
string currency_code = 6 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for currencyCode.
|
getDefaultInstanceForType()
public PurchaseTransaction getDefaultInstanceForType()
Returns
getId()
Optional. The transaction ID with a length limit of 128 bytes.
string id = 1 [(.google.api.field_behavior) = OPTIONAL];
getIdBytes()
public ByteString getIdBytes()
Optional. The transaction ID with a length limit of 128 bytes.
string id = 1 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<PurchaseTransaction> getParserForType()
Returns
Overrides
getRevenue()
public float getRevenue()
Required. Total revenue or grand total associated with the transaction.
This value include shipping, tax, or other adjustments to total revenue
that you want to include as part of your revenue calculations. This field
is not required if the event type is refund.
float revenue = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| float | The revenue.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTaxes()
public Map<String,Float> getTaxes()
Returns
getTaxesCount()
public int getTaxesCount()
Optional. All the taxes associated with the transaction.
map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
getTaxesMap()
public Map<String,Float> getTaxesMap()
Optional. All the taxes associated with the transaction.
map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
getTaxesOrDefault(String key, float defaultValue)
public float getTaxesOrDefault(String key, float defaultValue)
Optional. All the taxes associated with the transaction.
map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
getTaxesOrThrow(String key)
public float getTaxesOrThrow(String key)
Optional. All the taxes associated with the transaction.
map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PurchaseTransaction.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PurchaseTransaction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PurchaseTransaction.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
