Package com.google.cloud.retail.v2beta

Class Rating

  • All Implemented Interfaces:
    RatingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Rating
extends com.google.protobuf.GeneratedMessageV3
implements RatingOrBuilder
     The rating of a [Product][google.cloud.retail.v2beta.Product].
    Protobuf type google.cloud.retail.v2beta.Rating
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Rating.Builder
      The rating of a [Product][google.cloud.retail.v2beta.Product].

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int AVERAGE_RATING_FIELD_NUMBER  
      static int RATING_COUNT_FIELD_NUMBER  
      static int RATING_HISTOGRAM_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      float getAverageRating()
      The average rating of the [Product][google.cloud.retail.v2beta.Product].
      static Rating getDefaultInstance()  
      Rating getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<Rating> getParserForType()  
      int getRatingCount()
      The total number of ratings.
      int getRatingHistogram​(int index)
      List of rating counts per rating value (index = rating - 1).
      int getRatingHistogramCount()
      List of rating counts per rating value (index = rating - 1).
      List<Integer> getRatingHistogramList()
      List of rating counts per rating value (index = rating - 1).
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Rating.Builder newBuilder()  
      static Rating.Builder newBuilder​(Rating prototype)  
      Rating.Builder newBuilderForType()  
      protected Rating.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Rating parseDelimitedFrom​(InputStream input)  
      static Rating parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rating parseFrom​(byte[] data)  
      static Rating parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rating parseFrom​(com.google.protobuf.ByteString data)  
      static Rating parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rating parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Rating parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rating parseFrom​(InputStream input)  
      static Rating parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rating parseFrom​(ByteBuffer data)  
      static Rating parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Rating> parser()  
      Rating.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • RATING_COUNT_FIELD_NUMBER

        public static final int RATING_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVERAGE_RATING_FIELD_NUMBER

        public static final int AVERAGE_RATING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RATING_HISTOGRAM_FIELD_NUMBER

        public static final int RATING_HISTOGRAM_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getRatingCount

        public int getRatingCount()
         The total number of ratings. This value is independent of the value of
 [rating_histogram][google.cloud.retail.v2beta.Rating.rating_histogram].

 This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
 returned.
        int32 rating_count = 1;
        Specified by:
        getRatingCount in interface RatingOrBuilder
        Returns:
        The ratingCount.

      • getAverageRating

        public float getAverageRating()
         The average rating of the [Product][google.cloud.retail.v2beta.Product].

 The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is
 returned.
        float average_rating = 2;
        Specified by:
        getAverageRating in interface RatingOrBuilder
        Returns:
        The averageRating.

      • 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][google.cloud.retail.v2beta.Product] got 41 ratings with 1 star,
 14 ratings with 2 star, and so on.
        repeated int32 rating_histogram = 3;
        Specified by:
        getRatingHistogramList in interface RatingOrBuilder
        Returns:
        A list containing the ratingHistogram.

      • 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][google.cloud.retail.v2beta.Product] got 41 ratings with 1 star,
 14 ratings with 2 star, and so on.
        repeated int32 rating_histogram = 3;
        Specified by:
        getRatingHistogramCount in interface RatingOrBuilder
        Returns:
        The count of ratingHistogram.

      • getRatingHistogram

        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][google.cloud.retail.v2beta.Product] got 41 ratings with 1 star,
 14 ratings with 2 star, and so on.
        repeated int32 rating_histogram = 3;
        Specified by:
        getRatingHistogram in interface RatingOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The ratingHistogram at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Rating parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Rating parseFrom​(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Rating parseFrom​(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Rating parseFrom​(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Rating parseFrom​(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Rating parseFrom​(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Rating parseFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Rating.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Rating.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Rating.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Rating getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Rating> parser()

      • getParserForType

        public com.google.protobuf.Parser<Rating> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Rating getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder