IncludedPath Class

  • Reference
Package:
com.microsoft.azure.documentdb
Maven Artifact:
com.microsoft.azure:azure-documentdb:2.4.7

public class IncludedPath
extends JsonSerializable

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

Constructor Summary

Constructor Description
IncludedPath()

Constructor.
IncludedPath(String jsonString)

Constructor.
IncludedPath(JSONObject jsonObject)

Constructor.

Method Summary

Modifier and Type Method and Description
java.util.Collection<Index> getIndexes()

Gets the paths that are chosen to be indexed by the user.
java.lang.String getPath()

Gets path.
void setIndexes(Collection<Index> indexes)
void setPath(String path)

Sets path.

Methods inherited from JsonSerializable

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

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

IncludedPath

public IncludedPath()

Constructor.

IncludedPath

public IncludedPath(String jsonString)

Constructor.

Parameters:

jsonString - the json string that represents the included path.

IncludedPath

public IncludedPath(JSONObject jsonObject)

Constructor.

Parameters:

jsonObject - the json object that represents the included path.

Method Details

getIndexes

public Collection getIndexes()

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

Returns:

the included paths.

getPath

public String getPath()

Gets path.

Returns:

the path.

setIndexes

public void setIndexes(Collection indexes)

Parameters:

indexes

setPath

public void setPath(String path)

Sets path.

Parameters:

path - the path.

Applies to