222 строки
17 KiB
YAML
222 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy"
|
|
name: "IndexingPolicy"
|
|
nameWithType: "IndexingPolicy"
|
|
summary: "Cosmos DB indexing policy."
|
|
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 **IndexingPolicy**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.IndexingPolicy()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.IndexingPolicy()"
|
|
name: "IndexingPolicy()"
|
|
nameWithType: "IndexingPolicy.IndexingPolicy()"
|
|
summary: "Creates an instance of Indexing<wbr>Policy class."
|
|
syntax: "public IndexingPolicy()"
|
|
desc: "Creates an instance of IndexingPolicy class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.automatic()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.automatic()"
|
|
name: "automatic()"
|
|
nameWithType: "IndexingPolicy.automatic()"
|
|
summary: "Get the automatic property: Indicates if the indexing policy is automatic."
|
|
syntax: "public Boolean automatic()"
|
|
desc: "Get the automatic property: Indicates if the indexing policy is automatic."
|
|
returns:
|
|
description: "the automatic value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.compositeIndexes()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.compositeIndexes()"
|
|
name: "compositeIndexes()"
|
|
nameWithType: "IndexingPolicy.compositeIndexes()"
|
|
summary: "Get the composite<wbr>Indexes property: List of composite path list."
|
|
syntax: "public List<List<CompositePath>> compositeIndexes()"
|
|
desc: "Get the compositeIndexes property: List of composite path list."
|
|
returns:
|
|
description: "the compositeIndexes value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.CompositePath?alt=com.azure.resourcemanager.cosmos.models.CompositePath&text=CompositePath\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.excludedPaths()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.excludedPaths()"
|
|
name: "excludedPaths()"
|
|
nameWithType: "IndexingPolicy.excludedPaths()"
|
|
summary: "Get the excluded<wbr>Paths property: List of paths to exclude from indexing."
|
|
syntax: "public List<ExcludedPath> excludedPaths()"
|
|
desc: "Get the excludedPaths property: List of paths to exclude from indexing."
|
|
returns:
|
|
description: "the excludedPaths value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.ExcludedPath?alt=com.azure.resourcemanager.cosmos.models.ExcludedPath&text=ExcludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "IndexingPolicy.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Indexing<wbr>Policy 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 IndexingPolicy fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the IndexingPolicy."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of IndexingPolicy from the JsonReader."
|
|
returns:
|
|
description: "An instance of IndexingPolicy 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.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.includedPaths()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.includedPaths()"
|
|
name: "includedPaths()"
|
|
nameWithType: "IndexingPolicy.includedPaths()"
|
|
summary: "Get the included<wbr>Paths property: List of paths to include in the indexing."
|
|
syntax: "public List<IncludedPath> includedPaths()"
|
|
desc: "Get the includedPaths property: List of paths to include in the indexing."
|
|
returns:
|
|
description: "the includedPaths value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<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.IndexingPolicy.indexingMode()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.indexingMode()"
|
|
name: "indexingMode()"
|
|
nameWithType: "IndexingPolicy.indexingMode()"
|
|
summary: "Get the indexing<wbr>Mode property: Indicates the indexing mode."
|
|
syntax: "public IndexingMode indexingMode()"
|
|
desc: "Get the indexingMode property: Indicates the indexing mode."
|
|
returns:
|
|
description: "the indexingMode value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingMode?alt=com.azure.resourcemanager.cosmos.models.IndexingMode&text=IndexingMode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.spatialIndexes()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.spatialIndexes()"
|
|
name: "spatialIndexes()"
|
|
nameWithType: "IndexingPolicy.spatialIndexes()"
|
|
summary: "Get the spatial<wbr>Indexes property: List of spatial specifics."
|
|
syntax: "public List<SpatialSpec> spatialIndexes()"
|
|
desc: "Get the spatialIndexes property: List of spatial specifics."
|
|
returns:
|
|
description: "the spatialIndexes value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.SpatialSpec?alt=com.azure.resourcemanager.cosmos.models.SpatialSpec&text=SpatialSpec\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "IndexingPolicy.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.IndexingPolicy.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.validate()"
|
|
name: "validate()"
|
|
nameWithType: "IndexingPolicy.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withAutomatic(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withAutomatic(Boolean automatic)"
|
|
name: "withAutomatic(Boolean automatic)"
|
|
nameWithType: "IndexingPolicy.withAutomatic(Boolean automatic)"
|
|
summary: "Set the automatic property: Indicates if the indexing policy is automatic."
|
|
parameters:
|
|
- description: "the automatic value to set."
|
|
name: "automatic"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public IndexingPolicy withAutomatic(Boolean automatic)"
|
|
desc: "Set the automatic property: Indicates if the indexing policy is automatic."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withCompositeIndexes(java.util.List<java.util.List<com.azure.resourcemanager.cosmos.models.CompositePath>>)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withCompositeIndexes(List<List<CompositePath>> compositeIndexes)"
|
|
name: "withCompositeIndexes(List<List<CompositePath>> compositeIndexes)"
|
|
nameWithType: "IndexingPolicy.withCompositeIndexes(List<List<CompositePath>> compositeIndexes)"
|
|
summary: "Set the composite<wbr>Indexes property: List of composite path list."
|
|
parameters:
|
|
- description: "the compositeIndexes value to set."
|
|
name: "compositeIndexes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.CompositePath?alt=com.azure.resourcemanager.cosmos.models.CompositePath&text=CompositePath\" data-throw-if-not-resolved=\"False\" />>>"
|
|
syntax: "public IndexingPolicy withCompositeIndexes(List<List<CompositePath>> compositeIndexes)"
|
|
desc: "Set the compositeIndexes property: List of composite path list."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withExcludedPaths(java.util.List<com.azure.resourcemanager.cosmos.models.ExcludedPath>)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withExcludedPaths(List<ExcludedPath> excludedPaths)"
|
|
name: "withExcludedPaths(List<ExcludedPath> excludedPaths)"
|
|
nameWithType: "IndexingPolicy.withExcludedPaths(List<ExcludedPath> excludedPaths)"
|
|
summary: "Set the excluded<wbr>Paths property: List of paths to exclude from indexing."
|
|
parameters:
|
|
- description: "the excludedPaths value to set."
|
|
name: "excludedPaths"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.ExcludedPath?alt=com.azure.resourcemanager.cosmos.models.ExcludedPath&text=ExcludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexingPolicy withExcludedPaths(List<ExcludedPath> excludedPaths)"
|
|
desc: "Set the excludedPaths property: List of paths to exclude from indexing."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withIncludedPaths(java.util.List<com.azure.resourcemanager.cosmos.models.IncludedPath>)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withIncludedPaths(List<IncludedPath> includedPaths)"
|
|
name: "withIncludedPaths(List<IncludedPath> includedPaths)"
|
|
nameWithType: "IndexingPolicy.withIncludedPaths(List<IncludedPath> includedPaths)"
|
|
summary: "Set the included<wbr>Paths property: List of paths to include in the indexing."
|
|
parameters:
|
|
- description: "the includedPaths value to set."
|
|
name: "includedPaths"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.IncludedPath?alt=com.azure.resourcemanager.cosmos.models.IncludedPath&text=IncludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexingPolicy withIncludedPaths(List<IncludedPath> includedPaths)"
|
|
desc: "Set the includedPaths property: List of paths to include in the indexing."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withIndexingMode(com.azure.resourcemanager.cosmos.models.IndexingMode)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withIndexingMode(IndexingMode indexingMode)"
|
|
name: "withIndexingMode(IndexingMode indexingMode)"
|
|
nameWithType: "IndexingPolicy.withIndexingMode(IndexingMode indexingMode)"
|
|
summary: "Set the indexing<wbr>Mode property: Indicates the indexing mode."
|
|
parameters:
|
|
- description: "the indexingMode value to set."
|
|
name: "indexingMode"
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingMode?alt=com.azure.resourcemanager.cosmos.models.IndexingMode&text=IndexingMode\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IndexingPolicy withIndexingMode(IndexingMode indexingMode)"
|
|
desc: "Set the indexingMode property: Indicates the indexing mode."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withSpatialIndexes(java.util.List<com.azure.resourcemanager.cosmos.models.SpatialSpec>)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.IndexingPolicy.withSpatialIndexes(List<SpatialSpec> spatialIndexes)"
|
|
name: "withSpatialIndexes(List<SpatialSpec> spatialIndexes)"
|
|
nameWithType: "IndexingPolicy.withSpatialIndexes(List<SpatialSpec> spatialIndexes)"
|
|
summary: "Set the spatial<wbr>Indexes property: List of spatial specifics."
|
|
parameters:
|
|
- description: "the spatialIndexes value to set."
|
|
name: "spatialIndexes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.cosmos.models.SpatialSpec?alt=com.azure.resourcemanager.cosmos.models.SpatialSpec&text=SpatialSpec\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexingPolicy withSpatialIndexes(List<SpatialSpec> spatialIndexes)"
|
|
desc: "Set the spatialIndexes property: List of spatial specifics."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Cosmos DB indexing policy."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.IndexingPolicy?alt=com.azure.resourcemanager.cosmos.models.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.42.0
|