Module io.ebean.core

Package io.ebeanservice.docstore.api.mapping

Class DocumentMapping

java.lang.Object

io.ebeanservice.docstore.api.mapping.DocumentMapping

All Implemented Interfaces:

DocMapping

public final class DocumentMapping
extends Object
implements DocMapping

Mapping for a document stored in a doc store (like ElasticSearch).

Constructor Summary

Constructors

Constructor	Description
DocumentMapping(String queueId, String name, String type, FetchPath paths, DocPropertyMapping properties, int shards, int replicas)

Method Summary

Modifier and Type	Method	Description
String	name()	Return the name.
FetchPath	paths()	Return the document structure as PathProperties.
DocPropertyMapping	properties()	Return the document structure with mapping details.
String	queueId()	Return the queueId.
int	replicas()	Return the number of replicas.
void	replicas(int replicas)	Set the number of replicas.
int	shards()	Return the number of shards.
void	shards(int shards)	Set the number of shards.
String	type()	Return the type.
void	visit(DocPropertyVisitor visitor)	Visit all the properties in the document structure.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentMapping

public DocumentMapping(String queueId,
 String name,
 String type,
 FetchPath paths,
 DocPropertyMapping properties,
 int shards,
 int replicas)

Method Details

visit

public void visit(DocPropertyVisitor visitor)

Visit all the properties in the document structure.

queueId

public String queueId()

Return the queueId.

name

public String name()

Return the name.

type

public String type()

Return the type.

paths

public FetchPath paths()

Return the document structure as PathProperties.

properties

public DocPropertyMapping properties()

Return the document structure with mapping details.

shards

public int shards()

Return the number of shards.

shards

public void shards(int shards)

Set the number of shards.

replicas

public int replicas()

Return the number of replicas.

replicas

public void replicas(int replicas)

Set the number of replicas.