AggregateRatingBuilder

public final class AggregateRatingBuilder extends IndexableBuilder<AggregateRatingBuilder>

Builder to construct an Indexable for aggregate rating.

The aggregate rating can only be used as a parameter of other builders, and it cannot be passed to FirebaseAppIndex.update(Indexable...) directly.

For reference, see: //schema.org/AggregateRating.

Public Method Summary

AggregateRatingBuilder
setRatingCount(long ratingCount)
Sets the count of total number of ratings.
AggregateRatingBuilder
setRatingValue(String ratingValue)
Sets the rating value.

Inherited Method Summary

com.google.firebase.appindexing.builders.IndexableBuilder
final Indexable
build()
Finalize building the object.
T
put(String key, boolean... values)
Sets one or multiple boolean values for a property, replacing its previous values.
<S extends IndexableBuilder<?>> T
put(String key, S... values)
Sets one or multiple Indexable values for a property.
T
put(String key, Indexable... values)
Sets one or multiple Indexable values for a property, replacing its previous values.
T
put(String key, String... values)
Sets one or multiple string values for a property, replacing its previous values.
T
put(String key, long... values)
Sets one or multiple long values for a property, replacing its previous values.
T
setAlternateName(String... alternateNames)
Sets the alternate names for the content.
final T
setDescription(String description)
Sets the optional description of the content.
T
setId(String id)
Sets the ID for the Indexable.
final T
setImage(String url)
Sets the image of the content.
final <S extends IndexableBuilder<?>> T
setIsPartOf(S... collections)
Sets the sub-group or collection that this Indexable is part of.
final T
setKeywords(String... keywords)
Sets the keywords of the Indexable.
T
setMetadata(Indexable.Metadata.Builder metadataBuilder)
Sets the metadata.
final T
setName(String name)
Sets the name of the content, must not be null.
final T
setSameAs(String webUrl)
Sets the corresponding web URL.
final T
setUrl(String url)
Sets the URL.
Object
clone()
boolean
equals(Object arg0)
void
finalize()
final Class<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()

Public Methods

public AggregateRatingBuilder setRatingCount (long ratingCount)

Sets the count of total number of ratings.

Parameters
ratingCount The count of total number of ratings.

public AggregateRatingBuilder setRatingValue (String ratingValue)

Sets the rating value.

Parameters
ratingValue The rating value, ranged from 0.0 to 5.0. For example, "4.5".