com.mailslurp.models

Class SmsMatchOption

java.lang.Object

com.mailslurp.models.SmsMatchOption

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class SmsMatchOption
extends Object

Options for matching SMS messages in a phone number. Each match option object contains a `field`, `should` and `value` property. Together they form logical conditions such as `BODY` should `CONTAIN` value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SmsMatchOption.CustomTypeAdapterFactory
static class	SmsMatchOption.FieldEnum Fields of an SMS object that can be used to filter results
static class	SmsMatchOption.ShouldEnum How the value of the email field specified should be compared to the value given in the match options.

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_FIELD
static String	SERIALIZED_NAME_SHOULD
static String	SERIALIZED_NAME_VALUE

Constructor Summary

Constructors

Constructor and Description
SmsMatchOption()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
SmsMatchOption	field(SmsMatchOption.FieldEnum field)
static SmsMatchOption	fromJson(String jsonString) Create an instance of SmsMatchOption given an JSON string
SmsMatchOption.FieldEnum	getField() Fields of an SMS object that can be used to filter results
SmsMatchOption.ShouldEnum	getShould() How the value of the email field specified should be compared to the value given in the match options.
String	getValue() The value you wish to compare with the value of the field specified using the `should` value passed.
int	hashCode()
void	setField(SmsMatchOption.FieldEnum field)
void	setShould(SmsMatchOption.ShouldEnum should)
void	setValue(String value)
SmsMatchOption	should(SmsMatchOption.ShouldEnum should)
String	toJson() Convert an instance of SmsMatchOption to an JSON string
String	toString()
static void	validateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found
SmsMatchOption	value(String value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_FIELD

public static final String SERIALIZED_NAME_FIELD

See Also:

Constant Field Values

SERIALIZED_NAME_SHOULD

public static final String SERIALIZED_NAME_SHOULD

See Also:

Constant Field Values

SERIALIZED_NAME_VALUE

public static final String SERIALIZED_NAME_VALUE

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

SmsMatchOption

public SmsMatchOption()

Method Detail

field

public SmsMatchOption field(SmsMatchOption.FieldEnum field)

getField

@Nonnull
public SmsMatchOption.FieldEnum getField()

Fields of an SMS object that can be used to filter results

Returns:

field

setField

public void setField(SmsMatchOption.FieldEnum field)

should

public SmsMatchOption should(SmsMatchOption.ShouldEnum should)

getShould

@Nonnull
public SmsMatchOption.ShouldEnum getShould()

How the value of the email field specified should be compared to the value given in the match options.

Returns:

should

setShould

public void setShould(SmsMatchOption.ShouldEnum should)

value

public SmsMatchOption value(String value)

getValue

@Nonnull
public String getValue()

The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed.

Returns:

value

setValue

public void setValue(String value)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to SmsMatchOption

fromJson

public static SmsMatchOption fromJson(String jsonString)
                               throws IOException

Create an instance of SmsMatchOption given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of SmsMatchOption

Throws:

IOException - if the JSON string is invalid with respect to SmsMatchOption

toJson

public String toJson()

Convert an instance of SmsMatchOption to an JSON string

Returns:

JSON string