Class PurchaseTransaction (0.53.0)

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
Type Description
int

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

REVENUE_FIELD_NUMBER

public static final int REVENUE_FIELD_NUMBER
Field Value
Type Description
int

TAXES_FIELD_NUMBER

public static final int TAXES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PurchaseTransaction getDefaultInstance()
Returns
Type Description
PurchaseTransaction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PurchaseTransaction.Builder newBuilder()
Returns
Type Description
PurchaseTransaction.Builder

newBuilder(PurchaseTransaction prototype)

public static PurchaseTransaction.Builder newBuilder(PurchaseTransaction prototype)
Parameter
Name Description
prototype PurchaseTransaction
Returns
Type Description
PurchaseTransaction.Builder

parseDelimitedFrom(InputStream input)

public static PurchaseTransaction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurchaseTransaction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PurchaseTransaction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PurchaseTransaction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PurchaseTransaction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PurchaseTransaction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PurchaseTransaction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PurchaseTransaction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PurchaseTransaction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurchaseTransaction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PurchaseTransaction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PurchaseTransaction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurchaseTransaction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PurchaseTransaction> parser()
Returns
Type Description
Parser<PurchaseTransaction>

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

Parameter
Name Description
key String
Returns
Type Description
boolean

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCosts() (deprecated)

public Map<String,Float> getCosts()

Use #getCostsMap() instead.

Returns
Type Description
Map<String,Float>

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

Returns
Type Description
int

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

Returns
Type Description
Map<String,Float>

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

Parameters
Name Description
key String
defaultValue float
Returns
Type Description
float

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

Parameter
Name Description
key String
Returns
Type Description
float

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

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

Returns
Type Description
ByteString

The bytes for currencyCode.

getDefaultInstanceForType()

public PurchaseTransaction getDefaultInstanceForType()
Returns
Type Description
PurchaseTransaction

getId()

public String getId()

Optional. The transaction ID with a length limit of 128 bytes.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Optional. The transaction ID with a length limit of 128 bytes.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for id.

getParserForType()

public Parser<PurchaseTransaction> getParserForType()
Returns
Type Description
Parser<PurchaseTransaction>
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];

Returns
Type Description
float

The revenue.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTaxes() (deprecated)

public Map<String,Float> getTaxes()

Use #getTaxesMap() instead.

Returns
Type Description
Map<String,Float>

getTaxesCount()

public int getTaxesCount()

Optional. All the taxes associated with the transaction.

map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTaxesMap()

public Map<String,Float> getTaxesMap()

Optional. All the taxes associated with the transaction.

map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,Float>

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

Parameters
Name Description
key String
defaultValue float
Returns
Type Description
float

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

Parameter
Name Description
key String
Returns
Type Description
float

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PurchaseTransaction.Builder newBuilderForType()
Returns
Type Description
PurchaseTransaction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PurchaseTransaction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PurchaseTransaction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PurchaseTransaction.Builder toBuilder()
Returns
Type Description
PurchaseTransaction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException