CreateDomainOptions (mailslurp-client-java 15.17.17 API)

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

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class CreateDomainOptions
extends Object
```
Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either `HTTP` or `SMTP` type. The type of domain determines which inboxes can be used with it. `SMTP` inboxes use a mail server running `mx.mailslurp.com` while `HTTP` inboxes are handled by AWS SES.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CreateDomainOptions.CustomTypeAdapterFactory

static class CreateDomainOptions.DomainTypeEnum
Type of domain.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CreateDomainOptions.CustomTypeAdapterFactory`
`static class`	`CreateDomainOptions.DomainTypeEnum` Type of domain.

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_CREATED_CATCH_ALL_INBOX`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_DOMAIN`
`static String`	`SERIALIZED_NAME_DOMAIN_TYPE`

Constructor Summary

Constructors
Constructor and Description

CreateDomainOptions()

Constructors
Constructor and Description
`CreateDomainOptions()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateDomainOptions`	`createdCatchAllInbox(Boolean createdCatchAllInbox)`
`CreateDomainOptions`	`description(String description)`
`CreateDomainOptions`	`domain(String domain)`
`CreateDomainOptions`	`domainType(CreateDomainOptions.DomainTypeEnum domainType)`
`boolean`	`equals(Object o)`
`static CreateDomainOptions`	`fromJson(String jsonString)` Create an instance of CreateDomainOptions given an JSON string
`Boolean`	`getCreatedCatchAllInbox()` Whether to create a catch all inbox for the domain.
`String`	`getDescription()` Optional description of the domain.
`String`	`getDomain()` The top level domain you wish to use with MailSlurp.
`CreateDomainOptions.DomainTypeEnum`	`getDomainType()` Type of domain.
`int`	`hashCode()`
`void`	`setCreatedCatchAllInbox(Boolean createdCatchAllInbox)`
`void`	`setDescription(String description)`
`void`	`setDomain(String domain)`
`void`	`setDomainType(CreateDomainOptions.DomainTypeEnum domainType)`
`String`	`toJson()` Convert an instance of CreateDomainOptions 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_DOMAIN
```
public static final String SERIALIZED_NAME_DOMAIN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESCRIPTION
```
public static final String SERIALIZED_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATED_CATCH_ALL_INBOX
```
public static final String SERIALIZED_NAME_CREATED_CATCH_ALL_INBOX
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DOMAIN_TYPE
```
public static final String SERIALIZED_NAME_DOMAIN_TYPE
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - CreateDomainOptions
```
public CreateDomainOptions()
```
- Method Detail
  - domain
```
public CreateDomainOptions domain(String domain)
```
  - getDomain
```
@Nonnull
public String getDomain()
```
    The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.
    
    Returns:
    
    domain
  - setDomain
```
public void setDomain(String domain)
```
  - description
```
public CreateDomainOptions description(String description)
```
  - getDescription
```
@Nullable
public String getDescription()
```
    Optional description of the domain.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - createdCatchAllInbox
```
public CreateDomainOptions createdCatchAllInbox(Boolean createdCatchAllInbox)
```
  - getCreatedCatchAllInbox
```
@Nullable
public Boolean getCreatedCatchAllInbox()
```
    Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.
    
    Returns:
    
    createdCatchAllInbox
  - setCreatedCatchAllInbox
```
public void setCreatedCatchAllInbox(Boolean createdCatchAllInbox)
```
  - domainType
```
public CreateDomainOptions domainType(CreateDomainOptions.DomainTypeEnum domainType)
```
  - getDomainType
```
@Nullable
public CreateDomainOptions.DomainTypeEnum getDomainType()
```
    Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
    
    Returns:
    
    domainType
  - setDomainType
```
public void setDomainType(CreateDomainOptions.DomainTypeEnum domainType)
```
  - 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 CreateDomainOptions
  - fromJson
```
public static CreateDomainOptions fromJson(String jsonString)
                                    throws IOException
```
    Create an instance of CreateDomainOptions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CreateDomainOptions
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to CreateDomainOptions
  - toJson
```
public String toJson()
```
    Convert an instance of CreateDomainOptions to an JSON string
    
    Returns:
    
    JSON string

Class CreateDomainOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_DOMAIN

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_CREATED_CATCH_ALL_INBOX

SERIALIZED_NAME_DOMAIN_TYPE

openapiFields

openapiRequiredFields

Constructor Detail

CreateDomainOptions

Method Detail

domain

getDomain

setDomain

description

getDescription

setDescription

createdCatchAllInbox

getCreatedCatchAllInbox

setCreatedCatchAllInbox

domainType

getDomainType

setDomainType

equals

hashCode

toString

validateJsonObject

fromJson

toJson