Class PurchaseTransaction

  • All Implemented Interfaces:
    PurchaseTransactionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class PurchaseTransaction
    extends com.google.protobuf.GeneratedMessageV3
    implements PurchaseTransactionOrBuilder
     A transaction represents the entire purchase transaction.
     
    Protobuf type google.cloud.retail.v2alpha.PurchaseTransaction
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PurchaseTransaction.Builder
      A transaction represents the entire purchase transaction.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int COST_FIELD_NUMBER  
      static int CURRENCY_CODE_FIELD_NUMBER  
      static int ID_FIELD_NUMBER  
      static int REVENUE_FIELD_NUMBER  
      static int TAX_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         The transaction ID with a length limit of 128 characters.
         
        string id = 1;
        Specified by:
        getIdBytes in interface PurchaseTransactionOrBuilder
        Returns:
        The bytes for id.
      • getRevenue

        public float getRevenue()
         Required. Total non-zero 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.
         
        float revenue = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getRevenue in interface PurchaseTransactionOrBuilder
        Returns:
        The revenue.
      • getTax

        public float getTax()
         All the taxes associated with the transaction.
         
        float tax = 3;
        Specified by:
        getTax in interface PurchaseTransactionOrBuilder
        Returns:
        The tax.
      • 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 =
         [revenue][google.cloud.retail.v2alpha.PurchaseTransaction.revenue] -
         [tax][google.cloud.retail.v2alpha.PurchaseTransaction.tax] -
         [cost][google.cloud.retail.v2alpha.PurchaseTransaction.cost]
         
        float cost = 4;
        Specified by:
        getCost in interface PurchaseTransactionOrBuilder
        Returns:
        The cost.
      • getCurrencyCode

        public String getCurrencyCode()
         Required. Currency code. Use three-character ISO-4217 code.
         
        string currency_code = 5 [(.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.
         
        string currency_code = 5 [(.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.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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​(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
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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