Package com.google.cloud.recommendationengine.v1beta1

Interface PurchaseTransactionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PurchaseTransaction, PurchaseTransaction.Builder

public interface PurchaseTransactionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsCosts(String key)	Optional.
boolean	containsTaxes(String key)	Optional.
Map<String,Float>	getCosts()	Deprecated.
int	getCostsCount()	Optional.
Map<String,Float>	getCostsMap()	Optional.
float	getCostsOrDefault(String key, float defaultValue)	Optional.
float	getCostsOrThrow(String key)	Optional.
String	getCurrencyCode()	Required.
com.google.protobuf.ByteString	getCurrencyCodeBytes()	Required.
String	getId()	Optional.
com.google.protobuf.ByteString	getIdBytes()	Optional.
float	getRevenue()	Required.
Map<String,Float>	getTaxes()	Deprecated.
int	getTaxesCount()	Optional.
Map<String,Float>	getTaxesMap()	Optional.
float	getTaxesOrDefault(String key, float defaultValue)	Optional.
float	getTaxesOrThrow(String key)	Optional.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getId

String getId()

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

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

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

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

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

Returns:

The bytes for id.

getRevenue

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:

The revenue.

getTaxesCount

int getTaxesCount()

 Optional. All the taxes associated with the transaction.
 

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

containsTaxes

boolean containsTaxes(String key)

 Optional. All the taxes associated with the transaction.
 

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

getTaxes

@Deprecated
Map<String,Float> getTaxes()

Deprecated.

Use getTaxesMap() instead.

getTaxesMap

Map<String,Float> getTaxesMap()

 Optional. All the taxes associated with the transaction.
 

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

getTaxesOrDefault

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

float getTaxesOrThrow(String key)

 Optional. All the taxes associated with the transaction.
 

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

getCostsCount

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

containsCosts

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

getCosts

@Deprecated
Map<String,Float> getCosts()

Deprecated.

Use getCostsMap() instead.

getCostsMap

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

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

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

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:

The currencyCode.

getCurrencyCodeBytes

com.google.protobuf.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:

The bytes for currencyCode.