132 строки
9.7 KiB
YAML
132 строки
9.7 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.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: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **IndexingPolicy**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.IndexingPolicy()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.IndexingPolicy()"
|
|
name: "IndexingPolicy()"
|
|
nameWithType: "IndexingPolicy.IndexingPolicy()"
|
|
syntax: "public IndexingPolicy()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.automatic()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.automatic()"
|
|
name: "automatic()"
|
|
nameWithType: "IndexingPolicy.automatic()"
|
|
summary: "Get indicates if the indexing policy is automatic."
|
|
syntax: "public Boolean automatic()"
|
|
desc: "Get indicates if the indexing policy is automatic."
|
|
returns:
|
|
description: "the automatic value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.excludedPaths()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.excludedPaths()"
|
|
name: "excludedPaths()"
|
|
nameWithType: "IndexingPolicy.excludedPaths()"
|
|
summary: "Get list of paths to exclude from indexing."
|
|
syntax: "public List<ExcludedPath> excludedPaths()"
|
|
desc: "Get list of paths to exclude from indexing."
|
|
returns:
|
|
description: "the excludedPaths value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.ExcludedPath?alt=com.microsoft.azure.management.cosmosdb.ExcludedPath&text=ExcludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.includedPaths()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.includedPaths()"
|
|
name: "includedPaths()"
|
|
nameWithType: "IndexingPolicy.includedPaths()"
|
|
summary: "Get list of paths to include in the indexing."
|
|
syntax: "public List<IncludedPath> includedPaths()"
|
|
desc: "Get list of paths to include in the indexing."
|
|
returns:
|
|
description: "the includedPaths value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.IncludedPath?alt=com.microsoft.azure.management.cosmosdb.IncludedPath&text=IncludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.indexingMode()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.indexingMode()"
|
|
name: "indexingMode()"
|
|
nameWithType: "IndexingPolicy.indexingMode()"
|
|
summary: "Get indicates the indexing mode."
|
|
syntax: "public IndexingMode indexingMode()"
|
|
desc: "Get indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'."
|
|
returns:
|
|
description: "the indexingMode value"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.IndexingMode?alt=com.microsoft.azure.management.cosmosdb.IndexingMode&text=IndexingMode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.withAutomatic(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.withAutomatic(Boolean automatic)"
|
|
name: "withAutomatic(Boolean automatic)"
|
|
nameWithType: "IndexingPolicy.withAutomatic(Boolean automatic)"
|
|
summary: "Set indicates if the indexing policy is automatic."
|
|
parameters:
|
|
- description: "the automatic value to set"
|
|
name: "automatic"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IndexingPolicy withAutomatic(Boolean automatic)"
|
|
desc: "Set indicates if the indexing policy is automatic."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.IndexingPolicy?alt=com.microsoft.azure.management.cosmosdb.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.withExcludedPaths(java.util.List<com.microsoft.azure.management.cosmosdb.ExcludedPath>)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.withExcludedPaths(List<ExcludedPath> excludedPaths)"
|
|
name: "withExcludedPaths(List<ExcludedPath> excludedPaths)"
|
|
nameWithType: "IndexingPolicy.withExcludedPaths(List<ExcludedPath> excludedPaths)"
|
|
summary: "Set list of paths to exclude from indexing."
|
|
parameters:
|
|
- description: "the excludedPaths value to set"
|
|
name: "excludedPaths"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.ExcludedPath?alt=com.microsoft.azure.management.cosmosdb.ExcludedPath&text=ExcludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexingPolicy withExcludedPaths(List<ExcludedPath> excludedPaths)"
|
|
desc: "Set list of paths to exclude from indexing."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.IndexingPolicy?alt=com.microsoft.azure.management.cosmosdb.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.withIncludedPaths(java.util.List<com.microsoft.azure.management.cosmosdb.IncludedPath>)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.withIncludedPaths(List<IncludedPath> includedPaths)"
|
|
name: "withIncludedPaths(List<IncludedPath> includedPaths)"
|
|
nameWithType: "IndexingPolicy.withIncludedPaths(List<IncludedPath> includedPaths)"
|
|
summary: "Set list of paths to include in the indexing."
|
|
parameters:
|
|
- description: "the includedPaths value to set"
|
|
name: "includedPaths"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.IncludedPath?alt=com.microsoft.azure.management.cosmosdb.IncludedPath&text=IncludedPath\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexingPolicy withIncludedPaths(List<IncludedPath> includedPaths)"
|
|
desc: "Set list of paths to include in the indexing."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.IndexingPolicy?alt=com.microsoft.azure.management.cosmosdb.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.withIndexingMode(com.microsoft.azure.management.cosmosdb.IndexingMode)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.IndexingPolicy.withIndexingMode(IndexingMode indexingMode)"
|
|
name: "withIndexingMode(IndexingMode indexingMode)"
|
|
nameWithType: "IndexingPolicy.withIndexingMode(IndexingMode indexingMode)"
|
|
summary: "Set indicates the indexing mode."
|
|
parameters:
|
|
- description: "the indexingMode value to set"
|
|
name: "indexingMode"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.IndexingMode?alt=com.microsoft.azure.management.cosmosdb.IndexingMode&text=IndexingMode\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IndexingPolicy withIndexingMode(IndexingMode indexingMode)"
|
|
desc: "Set indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'."
|
|
returns:
|
|
description: "the IndexingPolicy object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.IndexingPolicy?alt=com.microsoft.azure.management.cosmosdb.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Cosmos DB indexing policy."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.cosmosdb"
|
|
artifact: com.microsoft.azure:azure-mgmt-cosmosdb:1.41.4
|