com.microsoft.azure.cosmosdb

Class IncludedPath

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.IncludedPath

All Implemented Interfaces:

Serializable

public class IncludedPath
extends JsonSerializable

Represents an included path of the IndexingPolicy in the Azure Cosmos DB database service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IncludedPath() Constructor.
IncludedPath(org.json.JSONObject jsonObject) Constructor.
IncludedPath(String jsonString) Constructor.

Method Summary

Modifier and Type	Method and Description
Collection<Index>	getIndexes() Gets the paths that are chosen to be indexed by the user.
String	getPath() Gets path.
void	setIndexes(Collection<Index> indexes)
void	setPath(String path) Sets path.

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludedPath

public IncludedPath()

Constructor.

IncludedPath

public IncludedPath(String jsonString)

Constructor.

Parameters:

jsonString - the json string that represents the included path.

IncludedPath

public IncludedPath(org.json.JSONObject jsonObject)

Constructor.

Parameters:

jsonObject - the json object that represents the included path.

Method Detail

getPath

public String getPath()

Gets path.

Returns:

the path.

setPath

public void setPath(String path)

Sets path.

Parameters:

path - the path.

getIndexes

public Collection<Index> getIndexes()

Gets the paths that are chosen to be indexed by the user.

Returns:

the included paths.

setIndexes

public void setIndexes(Collection<Index> indexes)