PriceInfo.Builder (proto-google-cloud-retail-v2alpha 2.35.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<PriceInfo.Builder>
    - - com.google.cloud.retail.v2alpha.PriceInfo.Builder

All Implemented Interfaces:

PriceInfoOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

PriceInfo
```
public static final class PriceInfo.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PriceInfo.Builder>
implements PriceInfoOrBuilder
```
```
 The price information of a [Product][google.cloud.retail.v2alpha.Product].
 
```
Protobuf type google.cloud.retail.v2alpha.PriceInfo

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PriceInfo.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`PriceInfo`	`build()`
`PriceInfo`	`buildPartial()`
`PriceInfo.Builder`	`clear()`
`PriceInfo.Builder`	`clearCost()` The costs associated with the sale of a particular product.
`PriceInfo.Builder`	`clearCurrencyCode()` The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
`PriceInfo.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`PriceInfo.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`PriceInfo.Builder`	`clearOriginalPrice()` Price of the product without any discount.
`PriceInfo.Builder`	`clearPrice()` Price of the product.
`PriceInfo.Builder`	`clearPriceEffectiveTime()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] starts to be effective.
`PriceInfo.Builder`	`clearPriceExpireTime()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] stops to be effective.
`PriceInfo.Builder`	`clearPriceRange()` Output only.
`PriceInfo.Builder`	`clone()`
`float`	`getCost()` The costs associated with the sale of a particular product.
`String`	`getCurrencyCode()` The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
`com.google.protobuf.ByteString`	`getCurrencyCodeBytes()` The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
`PriceInfo`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`float`	`getOriginalPrice()` Price of the product without any discount.
`float`	`getPrice()` Price of the product.
`com.google.protobuf.Timestamp`	`getPriceEffectiveTime()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] starts to be effective.
`com.google.protobuf.Timestamp.Builder`	`getPriceEffectiveTimeBuilder()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] starts to be effective.
`com.google.protobuf.TimestampOrBuilder`	`getPriceEffectiveTimeOrBuilder()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] starts to be effective.
`com.google.protobuf.Timestamp`	`getPriceExpireTime()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] stops to be effective.
`com.google.protobuf.Timestamp.Builder`	`getPriceExpireTimeBuilder()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] stops to be effective.
`com.google.protobuf.TimestampOrBuilder`	`getPriceExpireTimeOrBuilder()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] stops to be effective.
`PriceInfo.PriceRange`	`getPriceRange()` Output only.
`PriceInfo.PriceRange.Builder`	`getPriceRangeBuilder()` Output only.
`PriceInfo.PriceRangeOrBuilder`	`getPriceRangeOrBuilder()` Output only.
`boolean`	`hasPriceEffectiveTime()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] starts to be effective.
`boolean`	`hasPriceExpireTime()` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] stops to be effective.
`boolean`	`hasPriceRange()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`PriceInfo.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`PriceInfo.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`PriceInfo.Builder`	`mergeFrom(PriceInfo other)`
`PriceInfo.Builder`	`mergePriceEffectiveTime(com.google.protobuf.Timestamp value)` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] starts to be effective.
`PriceInfo.Builder`	`mergePriceExpireTime(com.google.protobuf.Timestamp value)` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] stops to be effective.
`PriceInfo.Builder`	`mergePriceRange(PriceInfo.PriceRange value)` Output only.
`PriceInfo.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`PriceInfo.Builder`	`setCost(float value)` The costs associated with the sale of a particular product.
`PriceInfo.Builder`	`setCurrencyCode(String value)` The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
`PriceInfo.Builder`	`setCurrencyCodeBytes(com.google.protobuf.ByteString value)` The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
`PriceInfo.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`PriceInfo.Builder`	`setOriginalPrice(float value)` Price of the product without any discount.
`PriceInfo.Builder`	`setPrice(float value)` Price of the product.
`PriceInfo.Builder`	`setPriceEffectiveTime(com.google.protobuf.Timestamp.Builder builderForValue)` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] starts to be effective.
`PriceInfo.Builder`	`setPriceEffectiveTime(com.google.protobuf.Timestamp value)` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] starts to be effective.
`PriceInfo.Builder`	`setPriceExpireTime(com.google.protobuf.Timestamp.Builder builderForValue)` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] stops to be effective.
`PriceInfo.Builder`	`setPriceExpireTime(com.google.protobuf.Timestamp value)` The timestamp when the [price][google.cloud.retail.v2alpha.PriceInfo.price] stops to be effective.
`PriceInfo.Builder`	`setPriceRange(PriceInfo.PriceRange.Builder builderForValue)` Output only.
`PriceInfo.Builder`	`setPriceRange(PriceInfo.PriceRange value)` Output only.
`PriceInfo.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`PriceInfo.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<PriceInfo.Builder>

clear
```
public PriceInfo.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<PriceInfo.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<PriceInfo.Builder>

getDefaultInstanceForType
```
public PriceInfo getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public PriceInfo build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public PriceInfo buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public PriceInfo.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<PriceInfo.Builder>

setField

public PriceInfo.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<PriceInfo.Builder>

clearField
```
public PriceInfo.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<PriceInfo.Builder>

clearOneof
```
public PriceInfo.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<PriceInfo.Builder>

setRepeatedField

public PriceInfo.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<PriceInfo.Builder>

addRepeatedField

public PriceInfo.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<PriceInfo.Builder>

mergeFrom
```
public PriceInfo.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<PriceInfo.Builder>

mergeFrom

public PriceInfo.Builder mergeFrom(PriceInfo other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PriceInfo.Builder>

mergeFrom
```
public PriceInfo.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<PriceInfo.Builder>

Throws:

IOException

getCurrencyCode

public String getCurrencyCode()

 The 3-letter currency code defined in [ISO
 4217](https://www.iso.org/iso-4217-currency-codes.html).

 If this field is an unrecognizable currency code, an INVALID_ARGUMENT
 error is returned.

 The
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s with the same
 [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
 must share the same
 [currency_code][google.cloud.retail.v2alpha.PriceInfo.currency_code].
 Otherwise, a FAILED_PRECONDITION error is returned.

string currency_code = 1;

Specified by:: getCurrencyCode in interface PriceInfoOrBuilder
Returns:: The currencyCode.

getCurrencyCodeBytes

public com.google.protobuf.ByteString getCurrencyCodeBytes()

 The 3-letter currency code defined in [ISO
 4217](https://www.iso.org/iso-4217-currency-codes.html).

 If this field is an unrecognizable currency code, an INVALID_ARGUMENT
 error is returned.

 The
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s with the same
 [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
 must share the same
 [currency_code][google.cloud.retail.v2alpha.PriceInfo.currency_code].
 Otherwise, a FAILED_PRECONDITION error is returned.

string currency_code = 1;

Specified by:: getCurrencyCodeBytes in interface PriceInfoOrBuilder
Returns:: The bytes for currencyCode.

setCurrencyCode

public PriceInfo.Builder setCurrencyCode(String value)

 The 3-letter currency code defined in [ISO
 4217](https://www.iso.org/iso-4217-currency-codes.html).

 If this field is an unrecognizable currency code, an INVALID_ARGUMENT
 error is returned.

 The
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s with the same
 [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
 must share the same
 [currency_code][google.cloud.retail.v2alpha.PriceInfo.currency_code].
 Otherwise, a FAILED_PRECONDITION error is returned.

string currency_code = 1;

Parameters:: value - The currencyCode to set.
Returns:: This builder for chaining.

clearCurrencyCode

public PriceInfo.Builder clearCurrencyCode()

 The 3-letter currency code defined in [ISO
 4217](https://www.iso.org/iso-4217-currency-codes.html).

 If this field is an unrecognizable currency code, an INVALID_ARGUMENT
 error is returned.

 The
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s with the same
 [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
 must share the same
 [currency_code][google.cloud.retail.v2alpha.PriceInfo.currency_code].
 Otherwise, a FAILED_PRECONDITION error is returned.

string currency_code = 1;

Returns:: This builder for chaining.

setCurrencyCodeBytes

public PriceInfo.Builder setCurrencyCodeBytes(com.google.protobuf.ByteString value)

 The 3-letter currency code defined in [ISO
 4217](https://www.iso.org/iso-4217-currency-codes.html).

 If this field is an unrecognizable currency code, an INVALID_ARGUMENT
 error is returned.

 The
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s with the same
 [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
 must share the same
 [currency_code][google.cloud.retail.v2alpha.PriceInfo.currency_code].
 Otherwise, a FAILED_PRECONDITION error is returned.

string currency_code = 1;

Parameters:: value - The bytes for currencyCode to set.
Returns:: This builder for chaining.

getPrice

public float getPrice()

 Price of the product.

 Google Merchant Center property
 [price](https://support.google.com/merchants/answer/6324371). Schema.org
 property [Offer.price](https://schema.org/price).

float price = 2;

Specified by:: getPrice in interface PriceInfoOrBuilder
Returns:: The price.

setPrice

public PriceInfo.Builder setPrice(float value)

 Price of the product.

 Google Merchant Center property
 [price](https://support.google.com/merchants/answer/6324371). Schema.org
 property [Offer.price](https://schema.org/price).

float price = 2;

Parameters:: value - The price to set.
Returns:: This builder for chaining.

clearPrice

public PriceInfo.Builder clearPrice()

 Price of the product.

 Google Merchant Center property
 [price](https://support.google.com/merchants/answer/6324371). Schema.org
 property [Offer.price](https://schema.org/price).

float price = 2;

Returns:: This builder for chaining.

getOriginalPrice

public float getOriginalPrice()

 Price of the product without any discount. If zero, by default set to be
 the [price][google.cloud.retail.v2alpha.PriceInfo.price]. If set,
 [original_price][google.cloud.retail.v2alpha.PriceInfo.original_price]
 should be greater than or equal to
 [price][google.cloud.retail.v2alpha.PriceInfo.price], otherwise an
 INVALID_ARGUMENT error is thrown.

float original_price = 3;

Specified by:: getOriginalPrice in interface PriceInfoOrBuilder
Returns:: The originalPrice.

setOriginalPrice

public PriceInfo.Builder setOriginalPrice(float value)

 Price of the product without any discount. If zero, by default set to be
 the [price][google.cloud.retail.v2alpha.PriceInfo.price]. If set,
 [original_price][google.cloud.retail.v2alpha.PriceInfo.original_price]
 should be greater than or equal to
 [price][google.cloud.retail.v2alpha.PriceInfo.price], otherwise an
 INVALID_ARGUMENT error is thrown.

float original_price = 3;

Parameters:: value - The originalPrice to set.
Returns:: This builder for chaining.

clearOriginalPrice

public PriceInfo.Builder clearOriginalPrice()

 Price of the product without any discount. If zero, by default set to be
 the [price][google.cloud.retail.v2alpha.PriceInfo.price]. If set,
 [original_price][google.cloud.retail.v2alpha.PriceInfo.original_price]
 should be greater than or equal to
 [price][google.cloud.retail.v2alpha.PriceInfo.price], otherwise an
 INVALID_ARGUMENT error is thrown.

float original_price = 3;

Returns:: This builder for chaining.

getCost

public float getCost()

 The costs associated with the sale of a particular product. Used for gross
 profit reporting.

 * Profit = [price][google.cloud.retail.v2alpha.PriceInfo.price] -
 [cost][google.cloud.retail.v2alpha.PriceInfo.cost]

 Google Merchant Center property
 [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).

float cost = 4;

Specified by:: getCost in interface PriceInfoOrBuilder
Returns:: The cost.

setCost

public PriceInfo.Builder setCost(float value)

 The costs associated with the sale of a particular product. Used for gross
 profit reporting.

 * Profit = [price][google.cloud.retail.v2alpha.PriceInfo.price] -
 [cost][google.cloud.retail.v2alpha.PriceInfo.cost]

 Google Merchant Center property
 [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).

float cost = 4;

Parameters:: value - The cost to set.
Returns:: This builder for chaining.

clearCost

public PriceInfo.Builder clearCost()

 The costs associated with the sale of a particular product. Used for gross
 profit reporting.

 * Profit = [price][google.cloud.retail.v2alpha.PriceInfo.price] -
 [cost][google.cloud.retail.v2alpha.PriceInfo.cost]

 Google Merchant Center property
 [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).

float cost = 4;

Returns:: This builder for chaining.