Class PurchaseTransaction.Builder (2.30.0)

public static final class PurchaseTransaction.Builder extends GeneratedMessageV3.Builder<PurchaseTransaction.Builder> implements PurchaseTransactionOrBuilder

A transaction represents the entire purchase transaction.

Protobuf type google.cloud.retail.v2.PurchaseTransaction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PurchaseTransaction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

build()

public PurchaseTransaction build()
Returns
TypeDescription
PurchaseTransaction

buildPartial()

public PurchaseTransaction buildPartial()
Returns
TypeDescription
PurchaseTransaction

clear()

public PurchaseTransaction.Builder clear()
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

clearCost()

public PurchaseTransaction.Builder clearCost()

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

float cost = 4;

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

clearCurrencyCode()

public PurchaseTransaction.Builder clearCurrencyCode()

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

string currency_code = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PurchaseTransaction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

clearId()

public PurchaseTransaction.Builder clearId()

The transaction ID with a length limit of 128 characters.

string id = 1;

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PurchaseTransaction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

clearRevenue()

public PurchaseTransaction.Builder clearRevenue()

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

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

clearTax()

public PurchaseTransaction.Builder clearTax()

All the taxes associated with the transaction.

float tax = 3;

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

clone()

public PurchaseTransaction.Builder clone()
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

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

float cost = 4;

Returns
TypeDescription
float

The cost.

getCurrencyCode()

public String getCurrencyCode()

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

string currency_code = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

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

string currency_code = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for currencyCode.

getDefaultInstanceForType()

public PurchaseTransaction getDefaultInstanceForType()
Returns
TypeDescription
PurchaseTransaction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getId()

public String getId()

The transaction ID with a length limit of 128 characters.

string id = 1;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

The transaction ID with a length limit of 128 characters.

string id = 1;

Returns
TypeDescription
ByteString

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

Returns
TypeDescription
float

The revenue.

getTax()

public float getTax()

All the taxes associated with the transaction.

float tax = 3;

Returns
TypeDescription
float

The tax.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PurchaseTransaction other)

public PurchaseTransaction.Builder mergeFrom(PurchaseTransaction other)
Parameter
NameDescription
otherPurchaseTransaction
Returns
TypeDescription
PurchaseTransaction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PurchaseTransaction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PurchaseTransaction.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PurchaseTransaction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

setCost(float value)

public PurchaseTransaction.Builder setCost(float value)

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

float cost = 4;

Parameter
NameDescription
valuefloat

The cost to set.

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

setCurrencyCode(String value)

public PurchaseTransaction.Builder setCurrencyCode(String value)

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

string currency_code = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The currencyCode to set.

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

setCurrencyCodeBytes(ByteString value)

public PurchaseTransaction.Builder setCurrencyCodeBytes(ByteString value)

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

string currency_code = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for currencyCode to set.

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PurchaseTransaction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

setId(String value)

public PurchaseTransaction.Builder setId(String value)

The transaction ID with a length limit of 128 characters.

string id = 1;

Parameter
NameDescription
valueString

The id to set.

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

setIdBytes(ByteString value)

public PurchaseTransaction.Builder setIdBytes(ByteString value)

The transaction ID with a length limit of 128 characters.

string id = 1;

Parameter
NameDescription
valueByteString

The bytes for id to set.

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PurchaseTransaction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides

setRevenue(float value)

public PurchaseTransaction.Builder setRevenue(float value)

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

Parameter
NameDescription
valuefloat

The revenue to set.

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

setTax(float value)

public PurchaseTransaction.Builder setTax(float value)

All the taxes associated with the transaction.

float tax = 3;

Parameter
NameDescription
valuefloat

The tax to set.

Returns
TypeDescription
PurchaseTransaction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PurchaseTransaction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PurchaseTransaction.Builder
Overrides