Class Rating.Builder

public static final class Rating.Builder extends GeneratedMessageV3.Builder<Rating.Builder> implements RatingOrBuilder

The rating of a Product.

Protobuf type google.cloud.retail.v2.Rating

Implements

RatingOrBuilder

Methods

addAllRatingHistogram(Iterable<? extends Integer> values)

public Rating.Builder addAllRatingHistogram(Iterable<? extends Integer> values)

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

repeated int32 rating_histogram = 3;

Parameter
NameDescription
valuesIterable<? extends java.lang.Integer>

The ratingHistogram to add.

Returns
TypeDescription
Rating.Builder

This builder for chaining.

addRatingHistogram(int value)

public Rating.Builder addRatingHistogram(int value)

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

repeated int32 rating_histogram = 3;

Parameter
NameDescription
valueint

The ratingHistogram to add.

Returns
TypeDescription
Rating.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Rating build()
Returns
TypeDescription
Rating

buildPartial()

public Rating buildPartial()
Returns
TypeDescription
Rating

clear()

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

clearAverageRating()

public Rating.Builder clearAverageRating()

The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.

float average_rating = 2;

Returns
TypeDescription
Rating.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRatingCount()

public Rating.Builder clearRatingCount()

The total number of ratings. This value is independent of the value of rating_histogram. This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 rating_count = 1;

Returns
TypeDescription
Rating.Builder

This builder for chaining.

clearRatingHistogram()

public Rating.Builder clearRatingHistogram()

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

repeated int32 rating_histogram = 3;

Returns
TypeDescription
Rating.Builder

This builder for chaining.

clone()

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

getAverageRating()

public float getAverageRating()

The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.

float average_rating = 2;

Returns
TypeDescription
float

The averageRating.

getDefaultInstanceForType()

public Rating getDefaultInstanceForType()
Returns
TypeDescription
Rating

getDescriptor()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getRatingCount()

public int getRatingCount()

The total number of ratings. This value is independent of the value of rating_histogram. This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 rating_count = 1;

Returns
TypeDescription
int

The ratingCount.

getRatingHistogram(int index)

public int getRatingHistogram(int index)

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

repeated int32 rating_histogram = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
int

The ratingHistogram at the given index.

getRatingHistogramCount()

public int getRatingHistogramCount()

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

repeated int32 rating_histogram = 3;

Returns
TypeDescription
int

The count of ratingHistogram.

getRatingHistogramList()

public List<Integer> getRatingHistogramList()

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

repeated int32 rating_histogram = 3;

Returns
TypeDescription
List<Integer>

A list containing the ratingHistogram.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Rating other)

public Rating.Builder mergeFrom(Rating other)
Parameter
NameDescription
otherRating
Returns
TypeDescription
Rating.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAverageRating(float value)

public Rating.Builder setAverageRating(float value)

The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.

float average_rating = 2;

Parameter
NameDescription
valuefloat

The averageRating to set.

Returns
TypeDescription
Rating.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setRatingCount(int value)

public Rating.Builder setRatingCount(int value)

The total number of ratings. This value is independent of the value of rating_histogram. This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 rating_count = 1;

Parameter
NameDescription
valueint

The ratingCount to set.

Returns
TypeDescription
Rating.Builder

This builder for chaining.

setRatingHistogram(int index, int value)

public Rating.Builder setRatingHistogram(int index, int value)

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

repeated int32 rating_histogram = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueint

The ratingHistogram to set.

Returns
TypeDescription
Rating.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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