Package com.google.cloud.recommendationengine.v1beta1

Class PurchaseTransaction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.recommendationengine.v1beta1.PurchaseTransaction
All Implemented Interfaces:
PurchaseTransactionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PurchaseTransaction extends com.google.protobuf.GeneratedMessage implements PurchaseTransactionOrBuilder
 A transaction represents the entire purchase transaction.
Protobuf type google.cloud.recommendationengine.v1beta1.PurchaseTransaction
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getId

      public String getId()
       Optional. The transaction ID with a length limit of 128 bytes.
      string id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getId in interface PurchaseTransactionOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       Optional. The transaction ID with a length limit of 128 bytes.
      string id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIdBytes in interface PurchaseTransactionOrBuilder
      Returns:
      The bytes for id.

    • 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];
      Specified by:
      getRevenue in interface PurchaseTransactionOrBuilder
      Returns:
      The revenue.

    • getTaxesCount

      public int getTaxesCount()
      Description copied from interface: PurchaseTransactionOrBuilder
       Optional. All the taxes associated with the transaction.
      map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaxesCount in interface PurchaseTransactionOrBuilder

    • containsTaxes

      public boolean containsTaxes(String key)
       Optional. All the taxes associated with the transaction.
      map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsTaxes in interface PurchaseTransactionOrBuilder

    • getTaxes

      @Deprecated public Map<String,Float> getTaxes()
      Deprecated.
      Use getTaxesMap() instead.
      Specified by:
      getTaxes in interface PurchaseTransactionOrBuilder

    • getTaxesMap

      public Map<String,Float> getTaxesMap()
       Optional. All the taxes associated with the transaction.
      map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaxesMap in interface PurchaseTransactionOrBuilder

    • getTaxesOrDefault

      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];
      Specified by:
      getTaxesOrDefault in interface PurchaseTransactionOrBuilder

    • getTaxesOrThrow

      public float getTaxesOrThrow(String key)
       Optional. All the taxes associated with the transaction.
      map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaxesOrThrow in interface PurchaseTransactionOrBuilder

    • getCostsCount

      public int getCostsCount()
      Description copied from interface: PurchaseTransactionOrBuilder
       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];
      Specified by:
      getCostsCount in interface PurchaseTransactionOrBuilder

    • containsCosts

      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];
      Specified by:
      containsCosts in interface PurchaseTransactionOrBuilder

    • getCosts

      @Deprecated public Map<String,Float> getCosts()
      Deprecated.
      Use getCostsMap() instead.
      Specified by:
      getCosts in interface PurchaseTransactionOrBuilder

    • 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];
      Specified by:
      getCostsMap in interface PurchaseTransactionOrBuilder

    • getCostsOrDefault

      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];
      Specified by:
      getCostsOrDefault in interface PurchaseTransactionOrBuilder

    • getCostsOrThrow

      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];
      Specified by:
      getCostsOrThrow in interface PurchaseTransactionOrBuilder

    • 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];
      Specified by:
      getCurrencyCode in interface PurchaseTransactionOrBuilder
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      public 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];
      Specified by:
      getCurrencyCodeBytes in interface PurchaseTransactionOrBuilder
      Returns:
      The bytes for currencyCode.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PurchaseTransaction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PurchaseTransaction parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PurchaseTransaction parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PurchaseTransaction parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PurchaseTransaction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PurchaseTransaction parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PurchaseTransaction parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PurchaseTransaction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PurchaseTransaction parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PurchaseTransaction parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PurchaseTransaction parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PurchaseTransaction parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PurchaseTransaction.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PurchaseTransaction.Builder newBuilder()

    • newBuilder

      public static PurchaseTransaction.Builder newBuilder(PurchaseTransaction prototype)

    • toBuilder

      public PurchaseTransaction.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PurchaseTransaction.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PurchaseTransaction getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PurchaseTransaction> parser()

    • getParserForType

      public com.google.protobuf.Parser<PurchaseTransaction> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PurchaseTransaction getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder