Class TransactionInfo (0.17.0)

public final class TransactionInfo extends GeneratedMessageV3 implements TransactionInfoOrBuilder

A transaction represents the entire purchase transaction.

Protobuf type google.cloud.discoveryengine.v1.TransactionInfo

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransactionInfo

Implements

TransactionInfoOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

COST_FIELD_NUMBER

public static final int COST_FIELD_NUMBER

Field Value
Type	Description
`int`

CURRENCY_FIELD_NUMBER

public static final int CURRENCY_FIELD_NUMBER

Field Value
Type	Description
`int`

DISCOUNT_VALUE_FIELD_NUMBER

public static final int DISCOUNT_VALUE_FIELD_NUMBER

Field Value
Type	Description
`int`

TAX_FIELD_NUMBER

public static final int TAX_FIELD_NUMBER

Field Value
Type	Description
`int`

TRANSACTION_ID_FIELD_NUMBER

public static final int TRANSACTION_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static TransactionInfo getDefaultInstance()

Returns
Type	Description
`TransactionInfo`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static TransactionInfo.Builder newBuilder()

Returns
Type	Description
`TransactionInfo.Builder`

newBuilder(TransactionInfo prototype)

public static TransactionInfo.Builder newBuilder(TransactionInfo prototype)

Parameter
Name	Description
`prototype`	`TransactionInfo`

Returns
Type	Description
`TransactionInfo.Builder`

parseDelimitedFrom(InputStream input)

public static TransactionInfo parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static TransactionInfo parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransactionInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static TransactionInfo parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransactionInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static TransactionInfo parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static TransactionInfo parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static TransactionInfo parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransactionInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransactionInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<TransactionInfo> parser()

Returns
Type	Description
`Parser<TransactionInfo>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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 - tax - cost

optional float cost = 5;

Returns
Type	Description
`float`	The cost.

getCurrency()

public String getCurrency()

Required. Currency code. Use three-character ISO-4217 code.

string currency = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The currency.

getCurrencyBytes()

public ByteString getCurrencyBytes()

Required. Currency code. Use three-character ISO-4217 code.

string currency = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for currency.

getDefaultInstanceForType()

public TransactionInfo getDefaultInstanceForType()

Returns
Type	Description
`TransactionInfo`

getDiscountValue()

public float getDiscountValue()

The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value

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

This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value:

Profit = value - tax - cost

optional float discount_value = 6;

Returns
Type	Description
`float`	The discountValue.

getParserForType()

public Parser<TransactionInfo> getParserForType()

Returns
Type	Description
`Parser<TransactionInfo>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getTax()

public float getTax()

All the taxes associated with the transaction.

optional float tax = 4;

Returns
Type	Description
`float`	The tax.

getTransactionId()

public String getTransactionId()

The transaction ID with a length limit of 128 characters.

string transaction_id = 3;

Returns
Type	Description
`String`	The transactionId.

getTransactionIdBytes()

public ByteString getTransactionIdBytes()

The transaction ID with a length limit of 128 characters.

string transaction_id = 3;

Returns
Type	Description
`ByteString`	The bytes for transactionId.

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

Returns
Type	Description
`float`	The value.

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 - tax - cost

optional float cost = 5;

Returns
Type	Description
`boolean`	Whether the cost field is set.

hasDiscountValue()

public boolean hasDiscountValue()

The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value

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

This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value:

Profit = value - tax - cost

optional float discount_value = 6;

Returns
Type	Description
`boolean`	Whether the discountValue field is set.

hasTax()

public boolean hasTax()

All the taxes associated with the transaction.

optional float tax = 4;

Returns
Type	Description
`boolean`	Whether the tax field is set.

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

Returns
Type	Description
`boolean`	Whether the value field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TransactionInfo.Builder newBuilderForType()

Returns
Type	Description
`TransactionInfo.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransactionInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`TransactionInfo.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TransactionInfo.Builder toBuilder()

Returns
Type	Description
`TransactionInfo.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`