java.lang.Object
- com.exoscale.sdk.model.SearchShardSettings

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

SearchShardSettings

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_CANCELLATION_BURST`
`static String`	`JSON_PROPERTY_CANCELLATION_RATE`
`static String`	`JSON_PROPERTY_CANCELLATION_RATIO`
`static String`	`JSON_PROPERTY_CPU_TIME_MILLIS_THRESHOLD`
`static String`	`JSON_PROPERTY_ELAPSED_TIME_MILLIS_THRESHOLD`
`static String`	`JSON_PROPERTY_HEAP_MOVING_AVERAGE_WINDOW_SIZE`
`static String`	`JSON_PROPERTY_HEAP_PERCENT_THRESHOLD`
`static String`	`JSON_PROPERTY_HEAP_VARIANCE`
`static String`	`JSON_PROPERTY_TOTAL_HEAP_PERCENT_THRESHOLD`

Constructor Summary

Constructors
Constructor Description

SearchShardSettings()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SearchShardSettings`	`cancellationBurst(BigDecimal cancellationBurst)`
`SearchShardSettings`	`cancellationRate(BigDecimal cancellationRate)`
`SearchShardSettings`	`cancellationRatio(BigDecimal cancellationRatio)`
`SearchShardSettings`	`cpuTimeMillisThreshold(Integer cpuTimeMillisThreshold)`
`SearchShardSettings`	`elapsedTimeMillisThreshold(Integer elapsedTimeMillisThreshold)`
`boolean`	`equals(Object o)`	Return true if this Search_shard_settings object is equal to o.
`BigDecimal`	`getCancellationBurst()`	The maximum number of search tasks to cancel in a single iteration of the observer thread.
`BigDecimal`	`getCancellationRate()`	The maximum number of tasks to cancel per millisecond of elapsed time.
`BigDecimal`	`getCancellationRatio()`	The maximum number of tasks to cancel, as a percentage of successful task completions.
`Integer`	`getCpuTimeMillisThreshold()`	The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation.
`Integer`	`getElapsedTimeMillisThreshold()`	The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation.
`Integer`	`getHeapMovingAverageWindowSize()`	The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage.
`BigDecimal`	`getHeapPercentThreshold()`	The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation.
`BigDecimal`	`getHeapVariance()`	The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation.
`BigDecimal`	`getTotalHeapPercentThreshold()`	The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied.
`int`	`hashCode()`
`SearchShardSettings`	`heapMovingAverageWindowSize(Integer heapMovingAverageWindowSize)`
`SearchShardSettings`	`heapPercentThreshold(BigDecimal heapPercentThreshold)`
`SearchShardSettings`	`heapVariance(BigDecimal heapVariance)`
`void`	`setCancellationBurst(BigDecimal cancellationBurst)`
`void`	`setCancellationRate(BigDecimal cancellationRate)`
`void`	`setCancellationRatio(BigDecimal cancellationRatio)`
`void`	`setCpuTimeMillisThreshold(Integer cpuTimeMillisThreshold)`
`void`	`setElapsedTimeMillisThreshold(Integer elapsedTimeMillisThreshold)`
`void`	`setHeapMovingAverageWindowSize(Integer heapMovingAverageWindowSize)`
`void`	`setHeapPercentThreshold(BigDecimal heapPercentThreshold)`
`void`	`setHeapVariance(BigDecimal heapVariance)`
`void`	`setTotalHeapPercentThreshold(BigDecimal totalHeapPercentThreshold)`
`String`	`toString()`
`SearchShardSettings`	`totalHeapPercentThreshold(BigDecimal totalHeapPercentThreshold)`
`String`	`toUrlQueryString()`	Convert the instance into URL query string.
`String`	`toUrlQueryString(String prefix)`	Convert the instance into URL query string.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_TOTAL_HEAP_PERCENT_THRESHOLD
```
public static final String JSON_PROPERTY_TOTAL_HEAP_PERCENT_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ELAPSED_TIME_MILLIS_THRESHOLD
```
public static final String JSON_PROPERTY_ELAPSED_TIME_MILLIS_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CANCELLATION_RATE
```
public static final String JSON_PROPERTY_CANCELLATION_RATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HEAP_VARIANCE
```
public static final String JSON_PROPERTY_HEAP_VARIANCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HEAP_MOVING_AVERAGE_WINDOW_SIZE
```
public static final String JSON_PROPERTY_HEAP_MOVING_AVERAGE_WINDOW_SIZE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CANCELLATION_RATIO
```
public static final String JSON_PROPERTY_CANCELLATION_RATIO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HEAP_PERCENT_THRESHOLD
```
public static final String JSON_PROPERTY_HEAP_PERCENT_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CPU_TIME_MILLIS_THRESHOLD
```
public static final String JSON_PROPERTY_CPU_TIME_MILLIS_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CANCELLATION_BURST
```
public static final String JSON_PROPERTY_CANCELLATION_BURST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchShardSettings
```
public SearchShardSettings()
```
- Method Detail
  - totalHeapPercentThreshold
```
public SearchShardSettings totalHeapPercentThreshold(BigDecimal totalHeapPercentThreshold)
```
  - getTotalHeapPercentThreshold
```
@Nullable
public BigDecimal getTotalHeapPercentThreshold()
```
    The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5 minimum: 0.0 maximum: 1.0
    
    Returns:
    
    totalHeapPercentThreshold
  - setTotalHeapPercentThreshold
```
public void setTotalHeapPercentThreshold(BigDecimal totalHeapPercentThreshold)
```
  - elapsedTimeMillisThreshold
```
public SearchShardSettings elapsedTimeMillisThreshold(Integer elapsedTimeMillisThreshold)
```
  - getElapsedTimeMillisThreshold
```
@Nullable
public Integer getElapsedTimeMillisThreshold()
```
    The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000 minimum: 0
    
    Returns:
    
    elapsedTimeMillisThreshold
  - setElapsedTimeMillisThreshold
```
public void setElapsedTimeMillisThreshold(Integer elapsedTimeMillisThreshold)
```
  - cancellationRate
```
public SearchShardSettings cancellationRate(BigDecimal cancellationRate)
```
  - getCancellationRate
```
@Nullable
public BigDecimal getCancellationRate()
```
    The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003 minimum: 0.0
    
    Returns:
    
    cancellationRate
  - setCancellationRate
```
public void setCancellationRate(BigDecimal cancellationRate)
```
  - heapVariance
```
public SearchShardSettings heapVariance(BigDecimal heapVariance)
```
  - getHeapVariance
```
@Nullable
public BigDecimal getHeapVariance()
```
    The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0 minimum: 0.0
    
    Returns:
    
    heapVariance
  - setHeapVariance
```
public void setHeapVariance(BigDecimal heapVariance)
```
  - heapMovingAverageWindowSize
```
public SearchShardSettings heapMovingAverageWindowSize(Integer heapMovingAverageWindowSize)
```
  - getHeapMovingAverageWindowSize
```
@Nullable
public Integer getHeapMovingAverageWindowSize()
```
    The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100 minimum: 0
    
    Returns:
    
    heapMovingAverageWindowSize
  - setHeapMovingAverageWindowSize
```
public void setHeapMovingAverageWindowSize(Integer heapMovingAverageWindowSize)
```
  - cancellationRatio
```
public SearchShardSettings cancellationRatio(BigDecimal cancellationRatio)
```
  - getCancellationRatio
```
@Nullable
public BigDecimal getCancellationRatio()
```
    The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1 minimum: 0.0 maximum: 1.0
    
    Returns:
    
    cancellationRatio
  - setCancellationRatio
```
public void setCancellationRatio(BigDecimal cancellationRatio)
```
  - heapPercentThreshold
```
public SearchShardSettings heapPercentThreshold(BigDecimal heapPercentThreshold)
```
  - getHeapPercentThreshold
```
@Nullable
public BigDecimal getHeapPercentThreshold()
```
    The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5 minimum: 0.0 maximum: 1.0
    
    Returns:
    
    heapPercentThreshold
  - setHeapPercentThreshold
```
public void setHeapPercentThreshold(BigDecimal heapPercentThreshold)
```
  - cpuTimeMillisThreshold
```
public SearchShardSettings cpuTimeMillisThreshold(Integer cpuTimeMillisThreshold)
```
  - getCpuTimeMillisThreshold
```
@Nullable
public Integer getCpuTimeMillisThreshold()
```
    The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000 minimum: 0
    
    Returns:
    
    cpuTimeMillisThreshold
  - setCpuTimeMillisThreshold
```
public void setCpuTimeMillisThreshold(Integer cpuTimeMillisThreshold)
```
  - cancellationBurst
```
public SearchShardSettings cancellationBurst(BigDecimal cancellationBurst)
```
  - getCancellationBurst
```
@Nullable
public BigDecimal getCancellationBurst()
```
    The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0 minimum: 1.0
    
    Returns:
    
    cancellationBurst
  - setCancellationBurst
```
public void setCancellationBurst(BigDecimal cancellationBurst)
```
  - equals
```
public boolean equals(Object o)
```
    Return true if this Search_shard_settings object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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

Class SearchShardSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_TOTAL_HEAP_PERCENT_THRESHOLD

JSON_PROPERTY_ELAPSED_TIME_MILLIS_THRESHOLD

JSON_PROPERTY_CANCELLATION_RATE

JSON_PROPERTY_HEAP_VARIANCE

JSON_PROPERTY_HEAP_MOVING_AVERAGE_WINDOW_SIZE

JSON_PROPERTY_CANCELLATION_RATIO

JSON_PROPERTY_HEAP_PERCENT_THRESHOLD

JSON_PROPERTY_CPU_TIME_MILLIS_THRESHOLD

JSON_PROPERTY_CANCELLATION_BURST

Constructor Detail

SearchShardSettings

Method Detail

totalHeapPercentThreshold

getTotalHeapPercentThreshold

setTotalHeapPercentThreshold

elapsedTimeMillisThreshold

getElapsedTimeMillisThreshold

setElapsedTimeMillisThreshold

cancellationRate

getCancellationRate

setCancellationRate

heapVariance

getHeapVariance

setHeapVariance

heapMovingAverageWindowSize

getHeapMovingAverageWindowSize

setHeapMovingAverageWindowSize

cancellationRatio

getCancellationRatio

setCancellationRatio

heapPercentThreshold

getHeapPercentThreshold

setHeapPercentThreshold

cpuTimeMillisThreshold

getCpuTimeMillisThreshold

setCpuTimeMillisThreshold

cancellationBurst

getCancellationBurst

setCancellationBurst

equals

hashCode

toString

toUrlQueryString

toUrlQueryString