azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.cosmos.models.IncludedPath.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cosmos.models.IncludedPath"
fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath"
name: "IncludedPath"
nameWithType: "IncludedPath"
summary: "The paths that are included in indexing."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **IncludedPath**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cosmos.models.IncludedPath?alt=com.azure.resourcemanager.cosmos.models.IncludedPath&text=IncludedPath\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.cosmos.models.IncludedPath.IncludedPath()"
  fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath.IncludedPath()"
  name: "IncludedPath()"
  nameWithType: "IncludedPath.IncludedPath()"
  summary: "Creates an instance of Included<wbr>Path class."
  syntax: "public IncludedPath()"
  desc: "Creates an instance of IncludedPath class."
methods:
- uid: "com.azure.resourcemanager.cosmos.models.IncludedPath.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "IncludedPath.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Included<wbr>Path from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static IncludedPath fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the IncludedPath."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of IncludedPath from the JsonReader."
  returns:
    description: "An instance of IncludedPath if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IncludedPath?alt=com.azure.resourcemanager.cosmos.models.IncludedPath&text=IncludedPath\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.IncludedPath.indexes()"
  fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath.indexes()"
  name: "indexes()"
  nameWithType: "IncludedPath.indexes()"
  summary: "Get the indexes property: List of indexes for this path."
  syntax: "public List<Indexes> indexes()"
  desc: "Get the indexes property: List of indexes for this path."
  returns:
    description: "the indexes value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.cosmos.models.Indexes?alt=com.azure.resourcemanager.cosmos.models.Indexes&text=Indexes\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cosmos.models.IncludedPath.path()"
  fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath.path()"
  name: "path()"
  nameWithType: "IncludedPath.path()"
  summary: "Get the path property: The path for which the indexing behavior applies to."
  syntax: "public String path()"
  desc: "Get the path property: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/\\*)."
  returns:
    description: "the path value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cosmos.models.IncludedPath.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "IncludedPath.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.IncludedPath.validate()"
  fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath.validate()"
  name: "validate()"
  nameWithType: "IncludedPath.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cosmos.models.IncludedPath.withIndexes(java.util.List<com.azure.resourcemanager.cosmos.models.Indexes>)"
  fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath.withIndexes(List<Indexes> indexes)"
  name: "withIndexes(List<Indexes> indexes)"
  nameWithType: "IncludedPath.withIndexes(List<Indexes> indexes)"
  summary: "Set the indexes property: List of indexes for this path."
  parameters:
  - description: "the indexes value to set."
    name: "indexes"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.cosmos.models.Indexes?alt=com.azure.resourcemanager.cosmos.models.Indexes&text=Indexes\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public IncludedPath withIndexes(List<Indexes> indexes)"
  desc: "Set the indexes property: List of indexes for this path."
  returns:
    description: "the IncludedPath object itself."
    type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IncludedPath?alt=com.azure.resourcemanager.cosmos.models.IncludedPath&text=IncludedPath\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.IncludedPath.withPath(java.lang.String)"
  fullName: "com.azure.resourcemanager.cosmos.models.IncludedPath.withPath(String path)"
  name: "withPath(String path)"
  nameWithType: "IncludedPath.withPath(String path)"
  summary: "Set the path property: The path for which the indexing behavior applies to."
  parameters:
  - description: "the path value to set."
    name: "path"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public IncludedPath withPath(String path)"
  desc: "Set the path property: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/\\*)."
  returns:
    description: "the IncludedPath object itself."
    type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IncludedPath?alt=com.azure.resourcemanager.cosmos.models.IncludedPath&text=IncludedPath\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The paths that are included in indexing."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cosmos.models.IncludedPath?alt=com.azure.resourcemanager.cosmos.models.IncludedPath&text=IncludedPath\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.cosmos.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.42.0