Share via

IncludedPath Class

  • Reference
Package:
com.microsoft.azure.cosmosdb

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.

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.

Inherited Members

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) JsonSerializable.getHashMap() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) JsonSerializable.getString(String propertyName) JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

Constructor Details

IncludedPath

public IncludedPath()

Constructor.

IncludedPath

public IncludedPath(String jsonString)

Constructor.

Parameters:

jsonString - the json string 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