public final class Rating extends GeneratedMessageV3 implements RatingOrBuilder
The rating of a Product.
Protobuf type google.cloud.retail.v2.Rating
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AVERAGE_RATING_FIELD_NUMBER
public static final int AVERAGE_RATING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RATING_COUNT_FIELD_NUMBER
public static final int RATING_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RATING_HISTOGRAM_FIELD_NUMBER
public static final int RATING_HISTOGRAM_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Rating getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Rating.Builder newBuilder()
newBuilder(Rating prototype)
public static Rating.Builder newBuilder(Rating prototype)
| Parameter |
|---|
| Name | Description |
prototype | Rating
|
public static Rating parseDelimitedFrom(InputStream input)
public static Rating parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Rating parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Rating parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Rating parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rating parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rating parseFrom(CodedInputStream input)
public static Rating parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Rating parseFrom(InputStream input)
public static Rating parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Rating parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Rating parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Rating> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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 |
|---|
| Type | Description |
float | The averageRating.
|
getDefaultInstanceForType()
public Rating getDefaultInstanceForType()
getParserForType()
public Parser<Rating> getParserForType()
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 |
|---|
| 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 | 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;
| 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Rating.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Rating.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Rating.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
