WaitForConditions (mailslurp-client-java 11.5.20 API)

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

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-04-02T22:56:45.878Z[GMT]")
public class WaitForConditions
extends Object
```
Conditions that a `waitForXEmails` endpoint operates on. The methods wait until given conditions are met or a timeout is reached. If the conditions are met without needing to wait the results will be returned immediately.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WaitForConditions.CountTypeEnum` How should the found count be compared to the expected count.
`static class`	`WaitForConditions.SortDirectionEnum` Direction to sort matching emails by created time

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_COUNT`
`static String`	`SERIALIZED_NAME_COUNT_TYPE`
`static String`	`SERIALIZED_NAME_INBOX_ID`
`static String`	`SERIALIZED_NAME_MATCHES`
`static String`	`SERIALIZED_NAME_SORT_DIRECTION`
`static String`	`SERIALIZED_NAME_TIMEOUT`
`static String`	`SERIALIZED_NAME_UNREAD_ONLY`

Constructor Summary

Constructors
Constructor and Description

WaitForConditions()

Constructors
Constructor and Description
`WaitForConditions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WaitForConditions`	`addMatchesItem(MatchOption matchesItem)`
`WaitForConditions`	`count(Integer count)`
`WaitForConditions`	`countType(WaitForConditions.CountTypeEnum countType)`
`boolean`	`equals(Object o)`
`Integer`	`getCount()` Number of results that should match conditions.
`WaitForConditions.CountTypeEnum`	`getCountType()` How should the found count be compared to the expected count.
`UUID`	`getInboxId()` ID of inbox to search within and apply conditions to.
`List<MatchOption>`	`getMatches()` Conditions that should be matched for an email to qualify for results.
`WaitForConditions.SortDirectionEnum`	`getSortDirection()` Direction to sort matching emails by created time
`Long`	`getTimeout()` Max time in milliseconds to retry the `waitFor` operation until conditions are met.
`Boolean`	`getUnreadOnly()` Apply conditions only to unread emails.
`int`	`hashCode()`
`WaitForConditions`	`inboxId(UUID inboxId)`
`WaitForConditions`	`matches(List<MatchOption> matches)`
`void`	`setCount(Integer count)`
`void`	`setCountType(WaitForConditions.CountTypeEnum countType)`
`void`	`setInboxId(UUID inboxId)`
`void`	`setMatches(List<MatchOption> matches)`
`void`	`setSortDirection(WaitForConditions.SortDirectionEnum sortDirection)`
`void`	`setTimeout(Long timeout)`
`void`	`setUnreadOnly(Boolean unreadOnly)`
`WaitForConditions`	`sortDirection(WaitForConditions.SortDirectionEnum sortDirection)`
`WaitForConditions`	`timeout(Long timeout)`
`String`	`toString()`
`WaitForConditions`	`unreadOnly(Boolean unreadOnly)`

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

- Field Detail
  - SERIALIZED_NAME_COUNT
```
public static final String SERIALIZED_NAME_COUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COUNT_TYPE
```
public static final String SERIALIZED_NAME_COUNT_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INBOX_ID
```
public static final String SERIALIZED_NAME_INBOX_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MATCHES
```
public static final String SERIALIZED_NAME_MATCHES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SORT_DIRECTION
```
public static final String SERIALIZED_NAME_SORT_DIRECTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TIMEOUT
```
public static final String SERIALIZED_NAME_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UNREAD_ONLY
```
public static final String SERIALIZED_NAME_UNREAD_ONLY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WaitForConditions
```
public WaitForConditions()
```
- Method Detail
  - count
```
public WaitForConditions count(Integer count)
```
  - getCount
```
@Nullable
public Integer getCount()
```
    Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation.
    
    Returns:
    
    count
  - setCount
```
public void setCount(Integer count)
```
  - countType
```
public WaitForConditions countType(WaitForConditions.CountTypeEnum countType)
```
  - getCountType
```
@Nullable
public WaitForConditions.CountTypeEnum getCountType()
```
    How should the found count be compared to the expected count.
    
    Returns:
    
    countType
  - setCountType
```
public void setCountType(WaitForConditions.CountTypeEnum countType)
```
  - inboxId
```
public WaitForConditions inboxId(UUID inboxId)
```
  - getInboxId
```
@Nullable
public UUID getInboxId()
```
    ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.
    
    Returns:
    
    inboxId
  - setInboxId
```
public void setInboxId(UUID inboxId)
```
  - matches
```
public WaitForConditions matches(List<MatchOption> matches)
```
  - addMatchesItem
```
public WaitForConditions addMatchesItem(MatchOption matchesItem)
```
  - getMatches
```
@Nullable
public List<MatchOption> getMatches()
```
    Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for.
    
    Returns:
    
    matches
  - setMatches
```
public void setMatches(List<MatchOption> matches)
```
  - sortDirection
```
public WaitForConditions sortDirection(WaitForConditions.SortDirectionEnum sortDirection)
```
  - getSortDirection
```
@Nullable
public WaitForConditions.SortDirectionEnum getSortDirection()
```
    Direction to sort matching emails by created time
    
    Returns:
    
    sortDirection
  - setSortDirection
```
public void setSortDirection(WaitForConditions.SortDirectionEnum sortDirection)
```
  - timeout
```
public WaitForConditions timeout(Long timeout)
```
  - getTimeout
```
@Nullable
public Long getTimeout()
```
    Max time in milliseconds to retry the `waitFor` operation until conditions are met.
    
    Returns:
    
    timeout
  - setTimeout
```
public void setTimeout(Long timeout)
```
  - unreadOnly
```
public WaitForConditions unreadOnly(Boolean unreadOnly)
```
  - getUnreadOnly
```
@Nullable
public Boolean getUnreadOnly()
```
    Apply conditions only to **unread** emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard.
    
    Returns:
    
    unreadOnly
  - setUnreadOnly
```
public void setUnreadOnly(Boolean unreadOnly)
```
  - 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

Class WaitForConditions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_COUNT

SERIALIZED_NAME_COUNT_TYPE

SERIALIZED_NAME_INBOX_ID

SERIALIZED_NAME_MATCHES

SERIALIZED_NAME_SORT_DIRECTION

SERIALIZED_NAME_TIMEOUT

SERIALIZED_NAME_UNREAD_ONLY

Constructor Detail

WaitForConditions

Method Detail

count

getCount

setCount

countType

getCountType

setCountType

inboxId

getInboxId

setInboxId

matches

addMatchesItem

getMatches

setMatches

sortDirection

getSortDirection

setSortDirection

timeout

getTimeout

setTimeout

unreadOnly

getUnreadOnly

setUnreadOnly

equals

hashCode

toString