Class Batch

java.lang.Object

com.suse.salt.netapi.datatypes.Batch

public class Batch
extends Object

A class representing the batch parameter. Salt uses a string for the batch parameter, but it accept strings representing both exact numerals and percents, so this class encapsulates the creation and usage of the batch strings, adding safety.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Batch.BatchBuilder	Helper class for building a Batch.

Field Summary

Fields

Modifier and Type	Field	Description
private String	batch
private Optional<Double>	delay
private Optional<Integer>	presencePingGatherJobTimeout
private Optional<Integer>	presencePingTimeout

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Batch(Batch.BatchBuilder builder)

Method Summary

Modifier and Type	Method	Description
static Batch	asAmount(int value)	Construct a Batch from a value representing an exact amount of items
static Batch	asPercent(int value)	Construct a Batch from a value representing a percent
static Batch.BatchBuilder	custom()	Returns a BatchBuilder for instantiating a custom Batch.
String	getBatch()
Optional<Double>	getDelay()
Map<String,Object>	getParams()
Optional<Integer>	getPresencePingGatherJobTimeout()
Optional<Integer>	getPresencePingTimeout()
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

batch

private String batch

delay

private Optional<Double> delay

presencePingTimeout

private Optional<Integer> presencePingTimeout

presencePingGatherJobTimeout

private Optional<Integer> presencePingGatherJobTimeout

Constructor Details

Batch

private Batch(Batch.BatchBuilder builder)

Method Details

toString

public String toString()

Overrides:

toString in class Object

getBatch

public String getBatch()

getDelay

public Optional<Double> getDelay()

getPresencePingTimeout

public Optional<Integer> getPresencePingTimeout()

getPresencePingGatherJobTimeout

public Optional<Integer> getPresencePingGatherJobTimeout()

getParams

public Map<String,Object> getParams()

asPercent

public static Batch asPercent(int value)

Construct a Batch from a value representing a percent

Parameters:

value - the percent, which must be greater than 0 and less than or equal to 100

Returns:

the Batch

asAmount

public static Batch asAmount(int value)

Construct a Batch from a value representing an exact amount of items

Parameters:

value - the exact amount of items, which must be greater than 0

Returns:

the Batch

custom

public static Batch.BatchBuilder custom()

Returns a BatchBuilder for instantiating a custom Batch.

Returns:

a BatchBuilder instance.