Share via


StringBeginsWithFilter Class

public final class StringBeginsWithFilter
extends Filter

StringBeginsWith Filter.

Constructor Summary

Constructor Description
StringBeginsWithFilter()

Creates an instance of StringBeginsWithFilter class.

Method Summary

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

Reads an instance of StringBeginsWithFilter from the JsonReader.

FilterOperatorType operatorType()

Get the operatorType property: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

List<String> values()

Get the values property: The set of filter values.

StringBeginsWithFilter withKey(String key)

Set the key property: The field/property in the event based on which you want to filter.

StringBeginsWithFilter withValues(List<String> values)

Set the values property: The set of filter values.

Methods inherited from Filter

Methods inherited from java.lang.Object

Constructor Details

StringBeginsWithFilter

public StringBeginsWithFilter()

Creates an instance of StringBeginsWithFilter class.

Method Details

fromJson

public static StringBeginsWithFilter fromJson(JsonReader jsonReader)

Reads an instance of StringBeginsWithFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of StringBeginsWithFilter 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 StringBeginsWithFilter.

operatorType

public FilterOperatorType operatorType()

Get the operatorType property: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.

Overrides:

StringBeginsWithFilter.operatorType()

Returns:

the operatorType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

StringBeginsWithFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

StringBeginsWithFilter.validate()

values

public List<String> values()

Get the values property: The set of filter values.

Returns:

the values value.

withKey

public StringBeginsWithFilter withKey(String key)

Set the key property: The field/property in the event based on which you want to filter.

Overrides:

StringBeginsWithFilter.withKey(String key)

Parameters:

key

withValues

public StringBeginsWithFilter withValues(List<String> values)

Set the values property: The set of filter values.

Parameters:

values - the values value to set.

Returns:

the StringBeginsWithFilter object itself.

Applies to