Class PurchaseTransaction.Builder

  • All Implemented Interfaces:
    PurchaseTransactionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    PurchaseTransaction

    public static final class PurchaseTransaction.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
    implements PurchaseTransactionOrBuilder
     A transaction represents the entire purchase transaction.
     
    Protobuf type google.cloud.recommendationengine.v1beta1.PurchaseTransaction
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • clear

        public PurchaseTransaction.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • getDefaultInstanceForType

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

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

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

        public PurchaseTransaction.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • setField

        public PurchaseTransaction.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • clearField

        public PurchaseTransaction.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • clearOneof

        public PurchaseTransaction.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • setRepeatedField

        public PurchaseTransaction.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                            int index,
                                                            Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • addRepeatedField

        public PurchaseTransaction.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                            Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • mergeFrom

        public PurchaseTransaction.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurchaseTransaction.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • mergeFrom

        public PurchaseTransaction.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurchaseTransaction.Builder>
        Throws:
        IOException
      • 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.
      • setId

        public PurchaseTransaction.Builder setId​(String value)
         Optional. The transaction ID with a length limit of 128 bytes.
         
        string id = 1 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.
      • clearId

        public PurchaseTransaction.Builder clearId()
         Optional. The transaction ID with a length limit of 128 bytes.
         
        string id = 1 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setIdBytes

        public PurchaseTransaction.Builder setIdBytes​(com.google.protobuf.ByteString value)
         Optional. The transaction ID with a length limit of 128 bytes.
         
        string id = 1 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.
      • 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.
      • setRevenue

        public PurchaseTransaction.Builder setRevenue​(float value)
         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];
        Parameters:
        value - The revenue to set.
        Returns:
        This builder for chaining.
      • clearRevenue

        public PurchaseTransaction.Builder clearRevenue()
         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:
        This builder for chaining.
      • 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
      • 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
      • removeTaxes

        public PurchaseTransaction.Builder removeTaxes​(String key)
         Optional. All the taxes associated with the transaction.
         
        map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
      • getMutableTaxes

        @Deprecated
        public Map<String,​Float> getMutableTaxes()
        Deprecated.
        Use alternate mutation accessors instead.
      • putTaxes

        public PurchaseTransaction.Builder putTaxes​(String key,
                                                    float value)
         Optional. All the taxes associated with the transaction.
         
        map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
      • putAllTaxes

        public PurchaseTransaction.Builder putAllTaxes​(Map<String,​Float> values)
         Optional. All the taxes associated with the transaction.
         
        map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];
      • 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
      • 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
      • removeCosts

        public PurchaseTransaction.Builder removeCosts​(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];
      • getMutableCosts

        @Deprecated
        public Map<String,​Float> getMutableCosts()
        Deprecated.
        Use alternate mutation accessors instead.
      • putCosts

        public PurchaseTransaction.Builder putCosts​(String key,
                                                    float value)
         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];
      • putAllCosts

        public PurchaseTransaction.Builder putAllCosts​(Map<String,​Float> values)
         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

        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.
      • setCurrencyCode

        public PurchaseTransaction.Builder setCurrencyCode​(String value)
         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];
        Parameters:
        value - The currencyCode to set.
        Returns:
        This builder for chaining.
      • clearCurrencyCode

        public PurchaseTransaction.Builder clearCurrencyCode()
         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:
        This builder for chaining.
      • setCurrencyCodeBytes

        public PurchaseTransaction.Builder setCurrencyCodeBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for currencyCode to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final PurchaseTransaction.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>
      • mergeUnknownFields

        public final PurchaseTransaction.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurchaseTransaction.Builder>