WaitForSmsConditions (mailslurp-client-java 15.17.17 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class WaitForSmsConditions
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`	`WaitForSmsConditions.CountTypeEnum` How result size should be compared with the expected size.
`static class`	`WaitForSmsConditions.CustomTypeAdapterFactory`
`static class`	`WaitForSmsConditions.SortDirectionEnum` Direction to sort matching SMSs 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_LIMIT`
`static String`	`SERIALIZED_NAME_MATCHES`
`static String`	`SERIALIZED_NAME_PHONE_NUMBER_ID`
`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

WaitForSmsConditions()

Constructors
Constructor and Description
`WaitForSmsConditions()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WaitForSmsConditions`	`addMatchesItem(SmsMatchOption matchesItem)`
`WaitForSmsConditions`	`before(OffsetDateTime before)`
`WaitForSmsConditions`	`count(Long count)`
`WaitForSmsConditions`	`countType(WaitForSmsConditions.CountTypeEnum countType)`
`WaitForSmsConditions`	`delayTimeout(Long delayTimeout)`
`boolean`	`equals(Object o)`
`static WaitForSmsConditions`	`fromJson(String jsonString)` Create an instance of WaitForSmsConditions given an JSON string
`OffsetDateTime`	`getBefore()` ISO Date Time latest time of SMS to consider.
`Long`	`getCount()` Number of results that should match conditions.
`WaitForSmsConditions.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.
`Integer`	`getLimit()` Limit results
`List<SmsMatchOption>`	`getMatches()` Conditions that should be matched for an SMS to qualify for results.
`UUID`	`getPhoneNumberId()` ID of phone number to search within and apply conditions to.
`OffsetDateTime`	`getSince()` ISO Date Time earliest time of SMS to consider.
`WaitForSmsConditions.SortDirectionEnum`	`getSortDirection()` Direction to sort matching SMSs 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 SMS.
`int`	`hashCode()`
`WaitForSmsConditions`	`limit(Integer limit)`
`WaitForSmsConditions`	`matches(List<SmsMatchOption> matches)`
`WaitForSmsConditions`	`phoneNumberId(UUID phoneNumberId)`
`void`	`setBefore(OffsetDateTime before)`
`void`	`setCount(Long count)`
`void`	`setCountType(WaitForSmsConditions.CountTypeEnum countType)`
`void`	`setDelayTimeout(Long delayTimeout)`
`void`	`setLimit(Integer limit)`
`void`	`setMatches(List<SmsMatchOption> matches)`
`void`	`setPhoneNumberId(UUID phoneNumberId)`
`void`	`setSince(OffsetDateTime since)`
`void`	`setSortDirection(WaitForSmsConditions.SortDirectionEnum sortDirection)`
`void`	`setTimeout(Long timeout)`
`void`	`setUnreadOnly(Boolean unreadOnly)`
`WaitForSmsConditions`	`since(OffsetDateTime since)`
`WaitForSmsConditions`	`sortDirection(WaitForSmsConditions.SortDirectionEnum sortDirection)`
`WaitForSmsConditions`	`timeout(Long timeout)`
`String`	`toJson()` Convert an instance of WaitForSmsConditions to an JSON string
`String`	`toString()`
`WaitForSmsConditions`	`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_PHONE_NUMBER_ID
```
public static final String SERIALIZED_NAME_PHONE_NUMBER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LIMIT
```
public static final String SERIALIZED_NAME_LIMIT
```
    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
  - WaitForSmsConditions
```
public WaitForSmsConditions()
```
- Method Detail
  - phoneNumberId
```
public WaitForSmsConditions phoneNumberId(UUID phoneNumberId)
```
  - getPhoneNumberId
```
@Nonnull
public UUID getPhoneNumberId()
```
    ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count.
    
    Returns:
    
    phoneNumberId
  - setPhoneNumberId
```
public void setPhoneNumberId(UUID phoneNumberId)
```
  - limit
```
public WaitForSmsConditions limit(Integer limit)
```
  - getLimit
```
@Nullable
public Integer getLimit()
```
    Limit results
    
    Returns:
    
    limit
  - setLimit
```
public void setLimit(Integer limit)
```
  - count
```
public WaitForSmsConditions count(Long count)
```
  - getCount
```
@Nonnull
public Long 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(Long count)
```
  - delayTimeout
```
public WaitForSmsConditions 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 WaitForSmsConditions 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 WaitForSmsConditions unreadOnly(Boolean unreadOnly)
```
  - getUnreadOnly
```
@Nullable
public Boolean getUnreadOnly()
```
    Apply conditions only to **unread** SMS. All SMS messages begin with `read=false`. An SMS is marked `read=true` when an `SMS` has been returned to the user at least once. For example you have called `getSms` or `waitForSms` etc., or you have viewed the SMS in the dashboard.
    
    Returns:
    
    unreadOnly
  - setUnreadOnly
```
public void setUnreadOnly(Boolean unreadOnly)
```
  - countType
```
public WaitForSmsConditions countType(WaitForSmsConditions.CountTypeEnum countType)
```
  - getCountType
```
@Nullable
public WaitForSmsConditions.CountTypeEnum getCountType()
```
    How result size should be compared with the expected size. Exactly or at-least matching result?
    
    Returns:
    
    countType
  - setCountType
```
public void setCountType(WaitForSmsConditions.CountTypeEnum countType)
```
  - matches
```
public WaitForSmsConditions matches(List<SmsMatchOption> matches)
```
  - addMatchesItem
```
public WaitForSmsConditions addMatchesItem(SmsMatchOption matchesItem)
```
  - getMatches
```
@Nullable
public List<SmsMatchOption> getMatches()
```
    Conditions that should be matched for an SMS to qualify for results. Each condition will be applied in order to each SMS within a phone number to filter a result list of matching SMSs you are waiting for.
    
    Returns:
    
    matches
  - setMatches
```
public void setMatches(List<SmsMatchOption> matches)
```
  - sortDirection
```
public WaitForSmsConditions sortDirection(WaitForSmsConditions.SortDirectionEnum sortDirection)
```
  - getSortDirection
```
@Nullable
public WaitForSmsConditions.SortDirectionEnum getSortDirection()
```
    Direction to sort matching SMSs by created time
    
    Returns:
    
    sortDirection
  - setSortDirection
```
public void setSortDirection(WaitForSmsConditions.SortDirectionEnum sortDirection)
```
  - since
```
public WaitForSmsConditions since(OffsetDateTime since)
```
  - getSince
```
@Nullable
public OffsetDateTime getSince()
```
    ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date
    
    Returns:
    
    since
  - setSince
```
public void setSince(OffsetDateTime since)
```
  - before
```
public WaitForSmsConditions before(OffsetDateTime before)
```
  - getBefore
```
@Nullable
public OffsetDateTime getBefore()
```
    ISO Date Time latest time of SMS to consider. Filter for matching SMSs 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 WaitForSmsConditions
  - fromJson
```
public static WaitForSmsConditions fromJson(String jsonString)
                                     throws IOException
```
    Create an instance of WaitForSmsConditions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of WaitForSmsConditions
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to WaitForSmsConditions
  - toJson
```
public String toJson()
```
    Convert an instance of WaitForSmsConditions to an JSON string
    
    Returns:
    
    JSON string

Class WaitForSmsConditions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_PHONE_NUMBER_ID

SERIALIZED_NAME_LIMIT

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

WaitForSmsConditions

Method Detail

phoneNumberId

getPhoneNumberId

setPhoneNumberId

limit

getLimit

setLimit

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