- 2.57.0 (latest)
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class Rating.Builder extends GeneratedMessageV3.Builder<Rating.Builder> implements RatingOrBuilderThe rating of a Product.
Protobuf type google.cloud.retail.v2.Rating
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rating.BuilderImplements
RatingOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Name | Description |
values |
Iterable<? extends java.lang.Integer>The ratingHistogram to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
intThe ratingHistogram to add. |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Rating.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
build()
public Rating build()| Returns | |
|---|---|
| Type | Description |
Rating |
|
buildPartial()
public Rating buildPartial()| Returns | |
|---|---|
| Type | Description |
Rating |
|
clear()
public Rating.Builder clear()| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
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 | |
|---|---|
| Type | Description |
Rating.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Rating.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Rating.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Rating.Builder |
This builder for chaining. |
clone()
public Rating.Builder clone()| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
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 | |
|---|---|
| Type | Description |
float |
The averageRating. |
getDefaultInstanceForType()
public Rating getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Rating |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the ratingHistogram. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Rating other)
public Rating.Builder mergeFrom(Rating other)| Parameter | |
|---|---|
| Name | Description |
other |
Rating |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Rating.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Rating.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Rating.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
floatThe averageRating to set. |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Rating.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
intThe ratingCount to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe ratingHistogram to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Rating.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rating.Builder |
|