Class Rating (2.41.0)

public final class Rating extends GeneratedMessageV3 implements RatingOrBuilder

The rating of a Product.

Protobuf type google.cloud.retail.v2.Rating

Implements

RatingOrBuilder

Static Fields

AVERAGE_RATING_FIELD_NUMBER

public static final int AVERAGE_RATING_FIELD_NUMBER
Field Value
TypeDescription
int

RATING_COUNT_FIELD_NUMBER

public static final int RATING_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

RATING_HISTOGRAM_FIELD_NUMBER

public static final int RATING_HISTOGRAM_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Rating getDefaultInstance()
Returns
TypeDescription
Rating

getDescriptor()

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

newBuilder()

public static Rating.Builder newBuilder()
Returns
TypeDescription
Rating.Builder

newBuilder(Rating prototype)

public static Rating.Builder newBuilder(Rating prototype)
Parameter
NameDescription
prototypeRating
Returns
TypeDescription
Rating.Builder

parseDelimitedFrom(InputStream input)

public static Rating parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rating
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rating parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rating
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Rating parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Rating
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rating parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rating
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rating parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Rating
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rating parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rating
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rating parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Rating
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rating parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rating
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Rating parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rating
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rating parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rating
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Rating parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Rating
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rating parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rating
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Rating> parser()
Returns
TypeDescription
Parser<Rating>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

getParserForType()

public Parser<Rating> getParserForType()
Returns
TypeDescription
Parser<Rating>
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Rating.Builder newBuilderForType()
Returns
TypeDescription
Rating.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rating.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Rating.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Rating.Builder toBuilder()
Returns
TypeDescription
Rating.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException