public static final class Rating.Builder extends GeneratedMessageV3.Builder<Rating.Builder> implements RatingOrBuilder
The rating of a Product.
Protobuf type google.cloud.retail.v2alpha.Rating
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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;
| Name | Description |
| values | Iterable<? extends java.lang.Integer>
The ratingHistogram to add.
|
Returns
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;
| Name | Description |
| value | int
The ratingHistogram to add.
|
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Rating.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Rating buildPartial()
Returns
clear()
public Rating.Builder clear()
Returns
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;
clearField(Descriptors.FieldDescriptor field)
public Rating.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public Rating.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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;
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;
clone()
public Rating.Builder clone()
Returns
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;
| Type | Description |
| float | The averageRating.
|
getDefaultInstanceForType()
public Rating getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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;
| Type | Description |
| 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;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| List<Integer> | A list containing the ratingHistogram.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Rating other)
public Rating.Builder mergeFrom(Rating other)
Parameter
Returns
public Rating.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Rating.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Rating.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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;
| Name | Description |
| value | float
The averageRating to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Rating.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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;
| Name | Description |
| value | int
The ratingCount to set.
|
Returns
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;
| Name | Description |
| index | int
The index to set the value at.
|
| value | int
The ratingHistogram to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Rating.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Rating.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
