Package io.quarkus.redis.datasource.search

Class Document

java.lang.Object

io.quarkus.redis.datasource.search.Document

public class Document
extends Object

Represents a document containing in the response of a ft.search command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Document.Property	Represents a document property / attribute

Constructor Summary

Constructors

Constructor	Description
Document(String id, double score, io.vertx.mutiny.redis.client.Response payload, Map<String,Document.Property> properties)

Method Summary

Modifier and Type	Method	Description
String	key()
io.vertx.mutiny.redis.client.Response	payload()
Map<String,Document.Property>	properties()
Document.Property	property(String name)	Gets a specific property from the document
double	score()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Document

public Document(String id,
                double score,
                io.vertx.mutiny.redis.client.Response payload,
                Map<String,Document.Property> properties)

Method Detail

key

public String key()

Returns:

the document key

score

public double score()

Returns:

the score, 0.0 if not requested

properties

public Map<String,Document.Property> properties()

Returns:

the list of properties of the document

property

public Document.Property property(String name)

Gets a specific property from the document

Parameters:

name - the name, must not be null

Returns:

the property, null if not found

payload

public io.vertx.mutiny.redis.client.Response payload()

Returns:

the payload