Class JsonSchemaOpensearch


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               comments="Generator version: 7.4.0")
    public class JsonSchemaOpensearch
    extends Object
    JsonSchemaOpensearch
    • Field Detail

      • JSON_PROPERTY_THREAD_POOL_SEARCH_THROTTLED_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_SEARCH_THROTTLED_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_ANALYZE_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_ANALYZE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_GET_QUEUE_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_GET_QUEUE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_INDICES_RECOVERY_MAX_CONCURRENT_FILE_CHUNKS

        public static final String JSON_PROPERTY_INDICES_RECOVERY_MAX_CONCURRENT_FILE_CHUNKS
        See Also:
        Constant Field Values
      • JSON_PROPERTY_INDICES_QUERIES_CACHE_SIZE

        public static final String JSON_PROPERTY_INDICES_QUERIES_CACHE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_SEARCH_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_SEARCH_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_INDICES_RECOVERY_MAX_BYTES_PER_SEC

        public static final String JSON_PROPERTY_INDICES_RECOVERY_MAX_BYTES_PER_SEC
        See Also:
        Constant Field Values
      • JSON_PROPERTY_HTTP_MAX_INITIAL_LINE_LENGTH

        public static final String JSON_PROPERTY_HTTP_MAX_INITIAL_LINE_LENGTH
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_WRITE_QUEUE_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_WRITE_QUEUE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_SCRIPT_MAX_COMPILATIONS_RATE

        public static final String JSON_PROPERTY_SCRIPT_MAX_COMPILATIONS_RATE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_REINDEX_REMOTE_WHITELIST

        public static final String JSON_PROPERTY_REINDEX_REMOTE_WHITELIST
        See Also:
        Constant Field Values
      • JSON_PROPERTY_OVERRIDE_MAIN_RESPONSE_VERSION

        public static final String JSON_PROPERTY_OVERRIDE_MAIN_RESPONSE_VERSION
        See Also:
        Constant Field Values
      • JSON_PROPERTY_INDICES_FIELDDATA_CACHE_SIZE

        public static final String JSON_PROPERTY_INDICES_FIELDDATA_CACHE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_ACTION_DESTRUCTIVE_REQUIRES_NAME

        public static final String JSON_PROPERTY_ACTION_DESTRUCTIVE_REQUIRES_NAME
        See Also:
        Constant Field Values
      • JSON_PROPERTY_PLUGINS_ALERTING_FILTER_BY_BACKEND_ROLES

        public static final String JSON_PROPERTY_PLUGINS_ALERTING_FILTER_BY_BACKEND_ROLES
        See Also:
        Constant Field Values
      • JSON_PROPERTY_INDICES_MEMORY_INDEX_BUFFER_SIZE

        public static final String JSON_PROPERTY_INDICES_MEMORY_INDEX_BUFFER_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_FORCE_MERGE_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_FORCE_MERGE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_AUTH_FAILURE_LISTENERS

        public static final String JSON_PROPERTY_AUTH_FAILURE_LISTENERS
        See Also:
        Constant Field Values
      • JSON_PROPERTY_CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_RECOVERIES

        public static final String JSON_PROPERTY_CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_RECOVERIES
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_ANALYZE_QUEUE_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_ANALYZE_QUEUE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_ACTION_AUTO_CREATE_INDEX_ENABLED

        public static final String JSON_PROPERTY_ACTION_AUTO_CREATE_INDEX_ENABLED
        See Also:
        Constant Field Values
      • JSON_PROPERTY_HTTP_MAX_CONTENT_LENGTH

        public static final String JSON_PROPERTY_HTTP_MAX_CONTENT_LENGTH
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_WRITE_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_WRITE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_SEARCH_QUEUE_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_SEARCH_QUEUE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_INDICES_QUERY_BOOL_MAX_CLAUSE_COUNT

        public static final String JSON_PROPERTY_INDICES_QUERY_BOOL_MAX_CLAUSE_COUNT
        See Also:
        Constant Field Values
      • JSON_PROPERTY_THREAD_POOL_SEARCH_THROTTLED_QUEUE_SIZE

        public static final String JSON_PROPERTY_THREAD_POOL_SEARCH_THROTTLED_QUEUE_SIZE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_CLUSTER_MAX_SHARDS_PER_NODE

        public static final String JSON_PROPERTY_CLUSTER_MAX_SHARDS_PER_NODE
        See Also:
        Constant Field Values
    • Constructor Detail

      • JsonSchemaOpensearch

        public JsonSchemaOpensearch()
    • Method Detail

      • getThreadPoolSearchThrottledSize

        @Nullable
        public Integer getThreadPoolSearchThrottledSize()
        Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. minimum: 1 maximum: 128
        Returns:
        threadPoolSearchThrottledSize
      • setThreadPoolSearchThrottledSize

        public void setThreadPoolSearchThrottledSize​(Integer threadPoolSearchThrottledSize)
      • getThreadPoolAnalyzeSize

        @Nullable
        public Integer getThreadPoolAnalyzeSize()
        Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. minimum: 1 maximum: 128
        Returns:
        threadPoolAnalyzeSize
      • setThreadPoolAnalyzeSize

        public void setThreadPoolAnalyzeSize​(Integer threadPoolAnalyzeSize)
      • getThreadPoolGetSize

        @Nullable
        public Integer getThreadPoolGetSize()
        Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. minimum: 1 maximum: 128
        Returns:
        threadPoolGetSize
      • setThreadPoolGetSize

        public void setThreadPoolGetSize​(Integer threadPoolGetSize)
      • getThreadPoolGetQueueSize

        @Nullable
        public Integer getThreadPoolGetQueueSize()
        Size for the thread pool queue. See documentation for exact details. minimum: 10 maximum: 2000
        Returns:
        threadPoolGetQueueSize
      • setThreadPoolGetQueueSize

        public void setThreadPoolGetQueueSize​(Integer threadPoolGetQueueSize)
      • indicesRecoveryMaxConcurrentFileChunks

        public JsonSchemaOpensearch indicesRecoveryMaxConcurrentFileChunks​(Integer indicesRecoveryMaxConcurrentFileChunks)
      • getIndicesRecoveryMaxConcurrentFileChunks

        @Nullable
        public Integer getIndicesRecoveryMaxConcurrentFileChunks()
        Number of file chunks sent in parallel for each recovery. Defaults to 2. minimum: 2 maximum: 5
        Returns:
        indicesRecoveryMaxConcurrentFileChunks
      • setIndicesRecoveryMaxConcurrentFileChunks

        public void setIndicesRecoveryMaxConcurrentFileChunks​(Integer indicesRecoveryMaxConcurrentFileChunks)
      • getIndicesQueriesCacheSize

        @Nullable
        public Integer getIndicesQueriesCacheSize()
        Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality. minimum: 3 maximum: 40
        Returns:
        indicesQueriesCacheSize
      • setIndicesQueriesCacheSize

        public void setIndicesQueriesCacheSize​(Integer indicesQueriesCacheSize)
      • getThreadPoolSearchSize

        @Nullable
        public Integer getThreadPoolSearchSize()
        Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. minimum: 1 maximum: 128
        Returns:
        threadPoolSearchSize
      • setThreadPoolSearchSize

        public void setThreadPoolSearchSize​(Integer threadPoolSearchSize)
      • getIndicesRecoveryMaxBytesPerSec

        @Nullable
        public Integer getIndicesRecoveryMaxBytesPerSec()
        Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb minimum: 40 maximum: 400
        Returns:
        indicesRecoveryMaxBytesPerSec
      • setIndicesRecoveryMaxBytesPerSec

        public void setIndicesRecoveryMaxBytesPerSec​(Integer indicesRecoveryMaxBytesPerSec)
      • getHttpMaxInitialLineLength

        @Nullable
        public Integer getHttpMaxInitialLineLength()
        The max length of an HTTP URL, in bytes minimum: 1024 maximum: 65536
        Returns:
        httpMaxInitialLineLength
      • setHttpMaxInitialLineLength

        public void setHttpMaxInitialLineLength​(Integer httpMaxInitialLineLength)
      • getEnableSecurityAudit

        @Nullable
        public Boolean getEnableSecurityAudit()
        Get enableSecurityAudit
        Returns:
        enableSecurityAudit
      • setEnableSecurityAudit

        public void setEnableSecurityAudit​(Boolean enableSecurityAudit)
      • getThreadPoolWriteQueueSize

        @Nullable
        public Integer getThreadPoolWriteQueueSize()
        Size for the thread pool queue. See documentation for exact details. minimum: 10 maximum: 2000
        Returns:
        threadPoolWriteQueueSize
      • setThreadPoolWriteQueueSize

        public void setThreadPoolWriteQueueSize​(Integer threadPoolWriteQueueSize)
      • getScriptMaxCompilationsRate

        @Nullable
        public String getScriptMaxCompilationsRate()
        Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context
        Returns:
        scriptMaxCompilationsRate
      • setScriptMaxCompilationsRate

        public void setScriptMaxCompilationsRate​(String scriptMaxCompilationsRate)
      • getSearchMaxBuckets

        @Nullable
        public Integer getSearchMaxBuckets()
        Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. minimum: 1 maximum: 1000000
        Returns:
        searchMaxBuckets
      • getSearchMaxBuckets_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<Integer> getSearchMaxBuckets_JsonNullable()
      • setSearchMaxBuckets_JsonNullable

        public void setSearchMaxBuckets_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<Integer> searchMaxBuckets)
      • setSearchMaxBuckets

        public void setSearchMaxBuckets​(Integer searchMaxBuckets)
      • addReindexRemoteWhitelistItem

        public JsonSchemaOpensearch addReindexRemoteWhitelistItem​(String reindexRemoteWhitelistItem)
      • getReindexRemoteWhitelist

        @Nullable
        public List<String> getReindexRemoteWhitelist()
        Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
        Returns:
        reindexRemoteWhitelist
      • getReindexRemoteWhitelist_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<List<String>> getReindexRemoteWhitelist_JsonNullable()
      • setReindexRemoteWhitelist_JsonNullable

        public void setReindexRemoteWhitelist_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<List<String>> reindexRemoteWhitelist)
      • setReindexRemoteWhitelist

        public void setReindexRemoteWhitelist​(List<String> reindexRemoteWhitelist)
      • getOverrideMainResponseVersion

        @Nullable
        public Boolean getOverrideMainResponseVersion()
        Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false
        Returns:
        overrideMainResponseVersion
      • setOverrideMainResponseVersion

        public void setOverrideMainResponseVersion​(Boolean overrideMainResponseVersion)
      • getHttpMaxHeaderSize

        @Nullable
        public Integer getHttpMaxHeaderSize()
        The max size of allowed headers, in bytes minimum: 1024 maximum: 262144
        Returns:
        httpMaxHeaderSize
      • setHttpMaxHeaderSize

        public void setHttpMaxHeaderSize​(Integer httpMaxHeaderSize)
      • getIndicesFielddataCacheSize

        @Nullable
        public Integer getIndicesFielddataCacheSize()
        Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations. minimum: 3 maximum: 100
        Returns:
        indicesFielddataCacheSize
      • getIndicesFielddataCacheSize_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<Integer> getIndicesFielddataCacheSize_JsonNullable()
      • setIndicesFielddataCacheSize_JsonNullable

        public void setIndicesFielddataCacheSize_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<Integer> indicesFielddataCacheSize)
      • setIndicesFielddataCacheSize

        public void setIndicesFielddataCacheSize​(Integer indicesFielddataCacheSize)
      • getActionDestructiveRequiresName

        @Nullable
        public Boolean getActionDestructiveRequiresName()
        Get actionDestructiveRequiresName
        Returns:
        actionDestructiveRequiresName
      • getActionDestructiveRequiresName_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<Boolean> getActionDestructiveRequiresName_JsonNullable()
      • setActionDestructiveRequiresName_JsonNullable

        public void setActionDestructiveRequiresName_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<Boolean> actionDestructiveRequiresName)
      • setActionDestructiveRequiresName

        public void setActionDestructiveRequiresName​(Boolean actionDestructiveRequiresName)
      • pluginsAlertingFilterByBackendRoles

        public JsonSchemaOpensearch pluginsAlertingFilterByBackendRoles​(Boolean pluginsAlertingFilterByBackendRoles)
      • getPluginsAlertingFilterByBackendRoles

        @Nullable
        public Boolean getPluginsAlertingFilterByBackendRoles()
        Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false
        Returns:
        pluginsAlertingFilterByBackendRoles
      • setPluginsAlertingFilterByBackendRoles

        public void setPluginsAlertingFilterByBackendRoles​(Boolean pluginsAlertingFilterByBackendRoles)
      • getIndicesMemoryIndexBufferSize

        @Nullable
        public Integer getIndicesMemoryIndexBufferSize()
        Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. minimum: 3 maximum: 40
        Returns:
        indicesMemoryIndexBufferSize
      • setIndicesMemoryIndexBufferSize

        public void setIndicesMemoryIndexBufferSize​(Integer indicesMemoryIndexBufferSize)
      • getThreadPoolForceMergeSize

        @Nullable
        public Integer getThreadPoolForceMergeSize()
        Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. minimum: 1 maximum: 128
        Returns:
        threadPoolForceMergeSize
      • setThreadPoolForceMergeSize

        public void setThreadPoolForceMergeSize​(Integer threadPoolForceMergeSize)
      • clusterRoutingAllocationNodeConcurrentRecoveries

        public JsonSchemaOpensearch clusterRoutingAllocationNodeConcurrentRecoveries​(Integer clusterRoutingAllocationNodeConcurrentRecoveries)
      • getClusterRoutingAllocationNodeConcurrentRecoveries

        @Nullable
        public Integer getClusterRoutingAllocationNodeConcurrentRecoveries()
        How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2. minimum: 2 maximum: 16
        Returns:
        clusterRoutingAllocationNodeConcurrentRecoveries
      • setClusterRoutingAllocationNodeConcurrentRecoveries

        public void setClusterRoutingAllocationNodeConcurrentRecoveries​(Integer clusterRoutingAllocationNodeConcurrentRecoveries)
      • getThreadPoolAnalyzeQueueSize

        @Nullable
        public Integer getThreadPoolAnalyzeQueueSize()
        Size for the thread pool queue. See documentation for exact details. minimum: 10 maximum: 2000
        Returns:
        threadPoolAnalyzeQueueSize
      • setThreadPoolAnalyzeQueueSize

        public void setThreadPoolAnalyzeQueueSize​(Integer threadPoolAnalyzeQueueSize)
      • getActionAutoCreateIndexEnabled

        @Nullable
        public Boolean getActionAutoCreateIndexEnabled()
        Explicitly allow or block automatic creation of indices. Defaults to true
        Returns:
        actionAutoCreateIndexEnabled
      • setActionAutoCreateIndexEnabled

        public void setActionAutoCreateIndexEnabled​(Boolean actionAutoCreateIndexEnabled)
      • getHttpMaxContentLength

        @Nullable
        public Integer getHttpMaxContentLength()
        Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. minimum: 1 maximum: 2147483647
        Returns:
        httpMaxContentLength
      • setHttpMaxContentLength

        public void setHttpMaxContentLength​(Integer httpMaxContentLength)
      • getThreadPoolWriteSize

        @Nullable
        public Integer getThreadPoolWriteSize()
        Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. minimum: 1 maximum: 128
        Returns:
        threadPoolWriteSize
      • setThreadPoolWriteSize

        public void setThreadPoolWriteSize​(Integer threadPoolWriteSize)
      • getThreadPoolSearchQueueSize

        @Nullable
        public Integer getThreadPoolSearchQueueSize()
        Size for the thread pool queue. See documentation for exact details. minimum: 10 maximum: 2000
        Returns:
        threadPoolSearchQueueSize
      • setThreadPoolSearchQueueSize

        public void setThreadPoolSearchQueueSize​(Integer threadPoolSearchQueueSize)
      • indicesQueryBoolMaxClauseCount

        public JsonSchemaOpensearch indicesQueryBoolMaxClauseCount​(Integer indicesQueryBoolMaxClauseCount)
      • getIndicesQueryBoolMaxClauseCount

        @Nullable
        public Integer getIndicesQueryBoolMaxClauseCount()
        Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value. minimum: 64 maximum: 4096
        Returns:
        indicesQueryBoolMaxClauseCount
      • setIndicesQueryBoolMaxClauseCount

        public void setIndicesQueryBoolMaxClauseCount​(Integer indicesQueryBoolMaxClauseCount)
      • threadPoolSearchThrottledQueueSize

        public JsonSchemaOpensearch threadPoolSearchThrottledQueueSize​(Integer threadPoolSearchThrottledQueueSize)
      • getThreadPoolSearchThrottledQueueSize

        @Nullable
        public Integer getThreadPoolSearchThrottledQueueSize()
        Size for the thread pool queue. See documentation for exact details. minimum: 10 maximum: 2000
        Returns:
        threadPoolSearchThrottledQueueSize
      • setThreadPoolSearchThrottledQueueSize

        public void setThreadPoolSearchThrottledQueueSize​(Integer threadPoolSearchThrottledQueueSize)
      • getClusterMaxShardsPerNode

        @Nullable
        public Integer getClusterMaxShardsPerNode()
        Controls the number of shards allowed in the cluster per data node minimum: 100 maximum: 10000
        Returns:
        clusterMaxShardsPerNode
      • setClusterMaxShardsPerNode

        public void setClusterMaxShardsPerNode​(Integer clusterMaxShardsPerNode)
      • equals

        public boolean equals​(Object o)
        Return true if this json-schema-opensearch object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • toUrlQueryString

        public String toUrlQueryString()
        Convert the instance into URL query string.
        Returns:
        URL query string
      • toUrlQueryString

        public String toUrlQueryString​(String prefix)
        Convert the instance into URL query string.
        Parameters:
        prefix - prefix of the query string
        Returns:
        URL query string