WaitForConditions (mailslurp-client-java 15.17.17 API)

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

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

Conditions to apply to emails that you are waiting for

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_BEFORE`
`static String`	`SERIALIZED_NAME_COUNT`
`static String`	`SERIALIZED_NAME_COUNT_TYPE`
`static String`	`SERIALIZED_NAME_DELAY_TIMEOUT`
`static String`	`SERIALIZED_NAME_INBOX_ID`
`static String`	`SERIALIZED_NAME_MATCHES`
`static String`	`SERIALIZED_NAME_SINCE`
`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 Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WaitForConditions`	`addMatchesItem(MatchOption matchesItem)`
`WaitForConditions`	`before(OffsetDateTime before)`
`WaitForConditions`	`count(Integer count)`
`WaitForConditions`	`countType(WaitForConditions.CountTypeEnum countType)`
`WaitForConditions`	`delayTimeout(Long delayTimeout)`
`boolean`	`equals(Object o)`
`static WaitForConditions`	`fromJson(String jsonString)` Create an instance of WaitForConditions given an JSON string
`OffsetDateTime`	`getBefore()` ISO Date Time latest time of email to consider.
`Integer`	`getCount()` Number of results that should match conditions.
`WaitForConditions.CountTypeEnum`	`getCountType()` How result size should be compared with the expected size.
`Long`	`getDelayTimeout()` Max time in milliseconds to wait between retries if a `timeout` is specified.
`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.
`OffsetDateTime`	`getSince()` ISO Date Time earliest time of email to consider.
`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`	`setBefore(OffsetDateTime before)`
`void`	`setCount(Integer count)`
`void`	`setCountType(WaitForConditions.CountTypeEnum countType)`
`void`	`setDelayTimeout(Long delayTimeout)`
`void`	`setInboxId(UUID inboxId)`
`void`	`setMatches(List<MatchOption> matches)`
`void`	`setSince(OffsetDateTime since)`
`void`	`setSortDirection(WaitForConditions.SortDirectionEnum sortDirection)`
`void`	`setTimeout(Long timeout)`
`void`	`setUnreadOnly(Boolean unreadOnly)`
`WaitForConditions`	`since(OffsetDateTime since)`
`WaitForConditions`	`sortDirection(WaitForConditions.SortDirectionEnum sortDirection)`
`WaitForConditions`	`timeout(Long timeout)`
`String`	`toJson()` Convert an instance of WaitForConditions to an JSON string
`String`	`toString()`
`WaitForConditions`	`unreadOnly(Boolean unreadOnly)`
`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_INBOX_ID
```
public static final String SERIALIZED_NAME_INBOX_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COUNT
```
public static final String SERIALIZED_NAME_COUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DELAY_TIMEOUT
```
public static final String SERIALIZED_NAME_DELAY_TIMEOUT
```
    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
  - SERIALIZED_NAME_COUNT_TYPE
```
public static final String SERIALIZED_NAME_COUNT_TYPE
```
    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_SINCE
```
public static final String SERIALIZED_NAME_SINCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BEFORE
```
public static final String SERIALIZED_NAME_BEFORE
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - WaitForConditions
```
public WaitForConditions()
```
- Method Detail
  - inboxId
```
public WaitForConditions inboxId(UUID inboxId)
```
  - getInboxId
```
@Nonnull
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)
```
  - 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)
```
  - delayTimeout
```
public WaitForConditions delayTimeout(Long delayTimeout)
```
  - getDelayTimeout
```
@Nullable
public Long getDelayTimeout()
```
    Max time in milliseconds to wait between retries if a `timeout` is specified.
    
    Returns:
    
    delayTimeout
  - setDelayTimeout
```
public void setDelayTimeout(Long delayTimeout)
```
  - timeout
```
public WaitForConditions timeout(Long timeout)
```
  - getTimeout
```
@Nonnull
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)
```
  - countType
```
public WaitForConditions countType(WaitForConditions.CountTypeEnum countType)
```
  - getCountType
```
@Nullable
public WaitForConditions.CountTypeEnum getCountType()
```
    How result size should be compared with the expected size. Exactly or at-least matching result?
    
    Returns:
    
    countType
  - setCountType
```
public void setCountType(WaitForConditions.CountTypeEnum countType)
```
  - 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)
```
  - since
```
public WaitForConditions since(OffsetDateTime since)
```
  - getSince
```
@Nullable
public OffsetDateTime getSince()
```
    ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date
    
    Returns:
    
    since
  - setSince
```
public void setSince(OffsetDateTime since)
```
  - before
```
public WaitForConditions before(OffsetDateTime before)
```
  - getBefore
```
@Nullable
public OffsetDateTime getBefore()
```
    ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date
    
    Returns:
    
    before
  - setBefore
```
public void setBefore(OffsetDateTime before)
```
  - 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 WaitForConditions
  - fromJson
```
public static WaitForConditions fromJson(String jsonString)
                                  throws IOException
```
    Create an instance of WaitForConditions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of WaitForConditions
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to WaitForConditions
  - toJson
```
public String toJson()
```
    Convert an instance of WaitForConditions to an JSON string
    
    Returns:
    
    JSON string

Class WaitForConditions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_INBOX_ID

SERIALIZED_NAME_COUNT

SERIALIZED_NAME_DELAY_TIMEOUT

SERIALIZED_NAME_TIMEOUT

SERIALIZED_NAME_UNREAD_ONLY

SERIALIZED_NAME_COUNT_TYPE

SERIALIZED_NAME_MATCHES

SERIALIZED_NAME_SORT_DIRECTION

SERIALIZED_NAME_SINCE

SERIALIZED_NAME_BEFORE

openapiFields

openapiRequiredFields

Constructor Detail

WaitForConditions

Method Detail

inboxId

getInboxId

setInboxId

count

getCount

setCount

delayTimeout

getDelayTimeout

setDelayTimeout

timeout

getTimeout

setTimeout

unreadOnly

getUnreadOnly

setUnreadOnly

countType

getCountType

setCountType

matches

addMatchesItem

getMatches

setMatches

sortDirection

getSortDirection

setSortDirection

since

getSince

setSince

before

getBefore

setBefore

equals

hashCode

toString

validateJsonObject

fromJson

toJson