Package com.google.cloud.discoveryengine.v1

Class TransactionInfo

  • All Implemented Interfaces:
    TransactionInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TransactionInfo
extends com.google.protobuf.GeneratedMessageV3
implements TransactionInfoOrBuilder
     A transaction represents the entire purchase transaction.
    Protobuf type google.cloud.discoveryengine.v1.TransactionInfo
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TransactionInfo.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

    • 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

      • hasValue

        public boolean hasValue()
         Required. Total non-zero value associated with the transaction. This value
 may include shipping, tax, or other adjustments to the total value that you
 want to include.
        optional float value = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasValue in interface TransactionInfoOrBuilder
        Returns:
        Whether the value field is set.

      • getValue

        public float getValue()
         Required. Total non-zero value associated with the transaction. This value
 may include shipping, tax, or other adjustments to the total value that you
 want to include.
        optional float value = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getValue in interface TransactionInfoOrBuilder
        Returns:
        The value.

      • getCurrency

        public String getCurrency()
         Required. Currency code. Use three-character ISO-4217 code.
        string currency = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCurrency in interface TransactionInfoOrBuilder
        Returns:
        The currency.

      • getCurrencyBytes

        public com.google.protobuf.ByteString getCurrencyBytes()
         Required. Currency code. Use three-character ISO-4217 code.
        string currency = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCurrencyBytes in interface TransactionInfoOrBuilder
        Returns:
        The bytes for currency.

      • getTransactionId

        public String getTransactionId()
         The transaction ID with a length limit of 128 characters.
        string transaction_id = 3;
        Specified by:
        getTransactionId in interface TransactionInfoOrBuilder
        Returns:
        The transactionId.

      • getTransactionIdBytes

        public com.google.protobuf.ByteString getTransactionIdBytes()
         The transaction ID with a length limit of 128 characters.
        string transaction_id = 3;
        Specified by:
        getTransactionIdBytes in interface TransactionInfoOrBuilder
        Returns:
        The bytes for transactionId.

      • hasTax

        public boolean hasTax()
         All the taxes associated with the transaction.
        optional float tax = 4;
        Specified by:
        hasTax in interface TransactionInfoOrBuilder
        Returns:
        Whether the tax field is set.

      • getTax

        public float getTax()
         All the taxes associated with the transaction.
        optional float tax = 4;
        Specified by:
        getTax in interface TransactionInfoOrBuilder
        Returns:
        The tax.

      • hasCost

        public boolean hasCost()
         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 = [value][google.cloud.discoveryengine.v1.TransactionInfo.value] -
 [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] -
 [cost][google.cloud.discoveryengine.v1.TransactionInfo.cost]
        optional float cost = 5;
        Specified by:
        hasCost in interface TransactionInfoOrBuilder
        Returns:
        Whether the cost field is set.

      • 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 = [value][google.cloud.discoveryengine.v1.TransactionInfo.value] -
 [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] -
 [cost][google.cloud.discoveryengine.v1.TransactionInfo.cost]
        optional float cost = 5;
        Specified by:
        getCost in interface TransactionInfoOrBuilder
        Returns:
        The cost.

      • hasDiscountValue

        public boolean hasDiscountValue()
         The total discount(s) value applied to this transaction.
 This figure should be excluded from
 [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]

 For example, if a user paid
 [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]
 amount, then nominal (pre-discount) value of the transaction is the sum of
 [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]
 and
 [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.TransactionInfo.discount_value]

 This means that profit is calculated the same way, regardless of the
 discount value, and that
 [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.TransactionInfo.discount_value]
 can be larger than
 [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]:

 * Profit = [value][google.cloud.discoveryengine.v1.TransactionInfo.value] -
 [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] -
 [cost][google.cloud.discoveryengine.v1.TransactionInfo.cost]
        optional float discount_value = 6;
        Specified by:
        hasDiscountValue in interface TransactionInfoOrBuilder
        Returns:
        Whether the discountValue field is set.

      • getDiscountValue

        public float getDiscountValue()
         The total discount(s) value applied to this transaction.
 This figure should be excluded from
 [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]

 For example, if a user paid
 [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]
 amount, then nominal (pre-discount) value of the transaction is the sum of
 [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]
 and
 [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.TransactionInfo.discount_value]

 This means that profit is calculated the same way, regardless of the
 discount value, and that
 [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.TransactionInfo.discount_value]
 can be larger than
 [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]:

 * Profit = [value][google.cloud.discoveryengine.v1.TransactionInfo.value] -
 [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] -
 [cost][google.cloud.discoveryengine.v1.TransactionInfo.cost]
        optional float discount_value = 6;
        Specified by:
        getDiscountValue in interface TransactionInfoOrBuilder
        Returns:
        The discountValue.

      • 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 TransactionInfo parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected TransactionInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<TransactionInfo> 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 TransactionInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder