MatchOptions (mailslurp-client-java 15.17.17 API)

java.lang.Object
- com.mailslurp.models.MatchOptions

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class MatchOptions
extends Object
```
Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value. An example payload would be `{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }`. You can also pass conditions such as `HAS_ATTACHMENT`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MatchOptions.CustomTypeAdapterFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`MatchOptions.CustomTypeAdapterFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_CONDITIONS`
`static String`	`SERIALIZED_NAME_MATCHES`

Constructor Summary

Constructors
Constructor and Description

MatchOptions()

Constructors
Constructor and Description
`MatchOptions()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MatchOptions`	`addConditionsItem(ConditionOption conditionsItem)`
`MatchOptions`	`addMatchesItem(MatchOption matchesItem)`
`MatchOptions`	`conditions(List<ConditionOption> conditions)`
`boolean`	`equals(Object o)`
`static MatchOptions`	`fromJson(String jsonString)` Create an instance of MatchOptions given an JSON string
`List<ConditionOption>`	`getConditions()` Zero or more conditions such as `{ condition: 'HAS_ATTACHMENTS', value: 'TRUE' }`.
`List<MatchOption>`	`getMatches()` Zero or more match options such as `{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }`.
`int`	`hashCode()`
`MatchOptions`	`matches(List<MatchOption> matches)`
`void`	`setConditions(List<ConditionOption> conditions)`
`void`	`setMatches(List<MatchOption> matches)`
`String`	`toJson()` Convert an instance of MatchOptions 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

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

- Field Detail
  - SERIALIZED_NAME_MATCHES
```
public static final String SERIALIZED_NAME_MATCHES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CONDITIONS
```
public static final String SERIALIZED_NAME_CONDITIONS
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - MatchOptions
```
public MatchOptions()
```
- Method Detail
  - matches
```
public MatchOptions matches(List<MatchOption> matches)
```
  - addMatchesItem
```
public MatchOptions addMatchesItem(MatchOption matchesItem)
```
  - getMatches
```
@Nullable
public List<MatchOption> getMatches()
```
    Zero or more match options such as `{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }`. Options are additive so if one does not match the email is excluded from results
    
    Returns:
    
    matches
  - setMatches
```
public void setMatches(List<MatchOption> matches)
```
  - conditions
```
public MatchOptions conditions(List<ConditionOption> conditions)
```
  - addConditionsItem
```
public MatchOptions addConditionsItem(ConditionOption conditionsItem)
```
  - getConditions
```
@Nullable
public List<ConditionOption> getConditions()
```
    Zero or more conditions such as `{ condition: 'HAS_ATTACHMENTS', value: 'TRUE' }`. Note the values are the strings `TRUE|FALSE` not booleans.
    
    Returns:
    
    conditions
  - setConditions
```
public void setConditions(List<ConditionOption> conditions)
```
  - 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 MatchOptions
  - fromJson
```
public static MatchOptions fromJson(String jsonString)
                             throws IOException
```
    Create an instance of MatchOptions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of MatchOptions
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to MatchOptions
  - toJson
```
public String toJson()
```
    Convert an instance of MatchOptions to an JSON string
    
    Returns:
    
    JSON string

Class MatchOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_MATCHES

SERIALIZED_NAME_CONDITIONS

openapiFields

openapiRequiredFields

Constructor Detail

MatchOptions

Method Detail

matches

addMatchesItem

getMatches

setMatches

conditions

addConditionsItem

getConditions

setConditions

equals

hashCode

toString

validateJsonObject

fromJson

toJson