SearchServiceLimits Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchServiceLimits

Implements

JsonSerializable<SearchServiceLimits>

public final class SearchServiceLimits
implements JsonSerializable<SearchServiceLimits>

Represents various service level limits.

Constructor Summary

Constructor Description
SearchServiceLimits()

Creates an instance of SearchServiceLimits class.

Method Summary

Modifier and Type Method and Description
static SearchServiceLimits fromJson(JsonReader jsonReader)

Reads an instance of SearchServiceLimits from the JsonReader.
Integer getMaxComplexCollectionFieldsPerIndex()

Get the maxComplexCollectionFieldsPerIndex property: The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.
Integer getMaxComplexObjectsInCollectionsPerDocument()

Get the maxComplexObjectsInCollectionsPerDocument property: The maximum number of objects in complex collections allowed per document.
Integer getMaxFieldNestingDepthPerIndex()

Get the maxFieldNestingDepthPerIndex property: The maximum depth which you can nest sub-fields in an index, including the top-level complex field.
Integer getMaxFieldsPerIndex()

Get the maxFieldsPerIndex property: The maximum allowed fields per index.
Long getMaxStoragePerIndexInBytes()

Get the maxStoragePerIndexInBytes property: The maximum amount of storage in bytes allowed per index.
SearchServiceLimits setMaxComplexCollectionFieldsPerIndex(Integer maxComplexCollectionFieldsPerIndex)

Set the maxComplexCollectionFieldsPerIndex property: The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.
SearchServiceLimits setMaxComplexObjectsInCollectionsPerDocument(Integer maxComplexObjectsInCollectionsPerDocument)

Set the maxComplexObjectsInCollectionsPerDocument property: The maximum number of objects in complex collections allowed per document.
SearchServiceLimits setMaxFieldNestingDepthPerIndex(Integer maxFieldNestingDepthPerIndex)

Set the maxFieldNestingDepthPerIndex property: The maximum depth which you can nest sub-fields in an index, including the top-level complex field.
SearchServiceLimits setMaxFieldsPerIndex(Integer maxFieldsPerIndex)

Set the maxFieldsPerIndex property: The maximum allowed fields per index.
SearchServiceLimits setMaxStoragePerIndexInBytes(Long maxStoragePerIndexInBytes)

Set the maxStoragePerIndexInBytes property: The maximum amount of storage in bytes allowed per index.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchServiceLimits

public SearchServiceLimits()

Creates an instance of SearchServiceLimits class.

Method Details

fromJson

public static SearchServiceLimits fromJson(JsonReader jsonReader)

Reads an instance of SearchServiceLimits from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchServiceLimits if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the SearchServiceLimits.

getMaxComplexCollectionFieldsPerIndex

public Integer getMaxComplexCollectionFieldsPerIndex()

Get the maxComplexCollectionFieldsPerIndex property: The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.

Returns:

the maxComplexCollectionFieldsPerIndex value.

getMaxComplexObjectsInCollectionsPerDocument

public Integer getMaxComplexObjectsInCollectionsPerDocument()

Get the maxComplexObjectsInCollectionsPerDocument property: The maximum number of objects in complex collections allowed per document.

Returns:

the maxComplexObjectsInCollectionsPerDocument value.

getMaxFieldNestingDepthPerIndex

public Integer getMaxFieldNestingDepthPerIndex()

Get the maxFieldNestingDepthPerIndex property: The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3.

Returns:

the maxFieldNestingDepthPerIndex value.

getMaxFieldsPerIndex

public Integer getMaxFieldsPerIndex()

Get the maxFieldsPerIndex property: The maximum allowed fields per index.

Returns:

the maxFieldsPerIndex value.

getMaxStoragePerIndexInBytes

public Long getMaxStoragePerIndexInBytes()

Get the maxStoragePerIndexInBytes property: The maximum amount of storage in bytes allowed per index.

Returns:

the maxStoragePerIndexInBytes value.

setMaxComplexCollectionFieldsPerIndex

public SearchServiceLimits setMaxComplexCollectionFieldsPerIndex(Integer maxComplexCollectionFieldsPerIndex)

Set the maxComplexCollectionFieldsPerIndex property: The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.

Parameters:

maxComplexCollectionFieldsPerIndex - the maxComplexCollectionFieldsPerIndex value to set.

Returns:

the SearchServiceLimits object itself.

setMaxComplexObjectsInCollectionsPerDocument

public SearchServiceLimits setMaxComplexObjectsInCollectionsPerDocument(Integer maxComplexObjectsInCollectionsPerDocument)

Set the maxComplexObjectsInCollectionsPerDocument property: The maximum number of objects in complex collections allowed per document.

Parameters:

maxComplexObjectsInCollectionsPerDocument - the maxComplexObjectsInCollectionsPerDocument value to set.

Returns:

the SearchServiceLimits object itself.

setMaxFieldNestingDepthPerIndex

public SearchServiceLimits setMaxFieldNestingDepthPerIndex(Integer maxFieldNestingDepthPerIndex)

Set the maxFieldNestingDepthPerIndex property: The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3.

Parameters:

maxFieldNestingDepthPerIndex - the maxFieldNestingDepthPerIndex value to set.

Returns:

the SearchServiceLimits object itself.

setMaxFieldsPerIndex

public SearchServiceLimits setMaxFieldsPerIndex(Integer maxFieldsPerIndex)

Set the maxFieldsPerIndex property: The maximum allowed fields per index.

Parameters:

maxFieldsPerIndex - the maxFieldsPerIndex value to set.

Returns:

the SearchServiceLimits object itself.

setMaxStoragePerIndexInBytes

public SearchServiceLimits setMaxStoragePerIndexInBytes(Long maxStoragePerIndexInBytes)

Set the maxStoragePerIndexInBytes property: The maximum amount of storage in bytes allowed per index.

Parameters:

maxStoragePerIndexInBytes - the maxStoragePerIndexInBytes value to set.

Returns:

the SearchServiceLimits object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to