DomainStatus (AWS SDK for Java 1.8.9 API)

java.lang.Object
- com.amazonaws.services.cloudsearchv2.model.DomainStatus

All Implemented Interfaces:

Serializable
```
public class DomainStatus
extends Object
implements Serializable
```
The current status of the search domain.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

DomainStatus()

Constructors
Constructor and Description
`DomainStatus()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getARN()` The Amazon Resource Name (ARN) of the search domain.
`Boolean`	`getCreated()` True if the search domain is created.
`Boolean`	`getDeleted()` True if the search domain has been deleted.
`ServiceEndpoint`	`getDocService()` The service endpoint for updating documents in a search domain.
`String`	`getDomainId()` An internally generated unique identifier for a domain.
`String`	`getDomainName()` A string that represents the name of a domain.
`Boolean`	`getProcessing()` True if processing is being done to activate the current domain configuration.
`Boolean`	`getRequiresIndexDocuments()` True if IndexDocuments needs to be called to activate the current domain configuration.
`Integer`	`getSearchInstanceCount()` The number of search instances that are available to process search requests.
`String`	`getSearchInstanceType()` The instance type that is being used to process search requests.
`Integer`	`getSearchPartitionCount()` The number of partitions across which the search index is spread.
`ServiceEndpoint`	`getSearchService()` The service endpoint for requesting search results from a search domain.
`int`	`hashCode()`
`Boolean`	`isCreated()` True if the search domain is created.
`Boolean`	`isDeleted()` True if the search domain has been deleted.
`Boolean`	`isProcessing()` True if processing is being done to activate the current domain configuration.
`Boolean`	`isRequiresIndexDocuments()` True if IndexDocuments needs to be called to activate the current domain configuration.
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the search domain.
`void`	`setCreated(Boolean created)` True if the search domain is created.
`void`	`setDeleted(Boolean deleted)` True if the search domain has been deleted.
`void`	`setDocService(ServiceEndpoint docService)` The service endpoint for updating documents in a search domain.
`void`	`setDomainId(String domainId)` An internally generated unique identifier for a domain.
`void`	`setDomainName(String domainName)` A string that represents the name of a domain.
`void`	`setProcessing(Boolean processing)` True if processing is being done to activate the current domain configuration.
`void`	`setRequiresIndexDocuments(Boolean requiresIndexDocuments)` True if IndexDocuments needs to be called to activate the current domain configuration.
`void`	`setSearchInstanceCount(Integer searchInstanceCount)` The number of search instances that are available to process search requests.
`void`	`setSearchInstanceType(String searchInstanceType)` The instance type that is being used to process search requests.
`void`	`setSearchPartitionCount(Integer searchPartitionCount)` The number of partitions across which the search index is spread.
`void`	`setSearchService(ServiceEndpoint searchService)` The service endpoint for requesting search results from a search domain.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DomainStatus`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the search domain.
`DomainStatus`	`withCreated(Boolean created)` True if the search domain is created.
`DomainStatus`	`withDeleted(Boolean deleted)` True if the search domain has been deleted.
`DomainStatus`	`withDocService(ServiceEndpoint docService)` The service endpoint for updating documents in a search domain.
`DomainStatus`	`withDomainId(String domainId)` An internally generated unique identifier for a domain.
`DomainStatus`	`withDomainName(String domainName)` A string that represents the name of a domain.
`DomainStatus`	`withProcessing(Boolean processing)` True if processing is being done to activate the current domain configuration.
`DomainStatus`	`withRequiresIndexDocuments(Boolean requiresIndexDocuments)` True if IndexDocuments needs to be called to activate the current domain configuration.
`DomainStatus`	`withSearchInstanceCount(Integer searchInstanceCount)` The number of search instances that are available to process search requests.
`DomainStatus`	`withSearchInstanceType(String searchInstanceType)` The instance type that is being used to process search requests.
`DomainStatus`	`withSearchPartitionCount(Integer searchPartitionCount)` The number of partitions across which the search index is spread.
`DomainStatus`	`withSearchService(ServiceEndpoint searchService)` The service endpoint for requesting search results from a search domain.

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

- Constructor Detail
  - DomainStatus
```
public DomainStatus()
```
- Method Detail
  - getDomainId
```
public String getDomainId()
```
    An internally generated unique identifier for a domain.
    Constraints:
    Length: 1 - 64
    
    Returns:
    An internally generated unique identifier for a domain.
  - setDomainId
```
public void setDomainId(String domainId)
```
    An internally generated unique identifier for a domain.
    Constraints:
    Length: 1 - 64
    
    Parameters:
    domainId - An internally generated unique identifier for a domain.
  - withDomainId
```
public DomainStatus withDomainId(String domainId)
```
    An internally generated unique identifier for a domain.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    
    Parameters:
    domainId - An internally generated unique identifier for a domain.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDomainName
```
public String getDomainName()
```
    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    Constraints:
    Length: 3 - 28
    Pattern: [a-z][a-z0-9\-]+
    
    Returns:
    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  - setDomainName
```
public void setDomainName(String domainName)
```
    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    Constraints:
    Length: 3 - 28
    Pattern: [a-z][a-z0-9\-]+
    
    Parameters:
    domainName - A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  - withDomainName
```
public DomainStatus withDomainName(String domainName)
```
    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 3 - 28
    Pattern: [a-z][a-z0-9\-]+
    
    Parameters:
    domainName - A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
    
    Returns:
    The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
    
    Parameters:
    aRN - The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
  - withARN
```
public DomainStatus withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    aRN - The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isCreated
```
public Boolean isCreated()
```
    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
    
    Returns:
    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
  - setCreated
```
public void setCreated(Boolean created)
```
    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
    
    Parameters:
    created - True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
  - withCreated
```
public DomainStatus withCreated(Boolean created)
```
    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    created - True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getCreated
```
public Boolean getCreated()
```
    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
    
    Returns:
    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
  - isDeleted
```
public Boolean isDeleted()
```
    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
    
    Returns:
    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
  - setDeleted
```
public void setDeleted(Boolean deleted)
```
    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
    
    Parameters:
    deleted - True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
  - withDeleted
```
public DomainStatus withDeleted(Boolean deleted)
```
    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    deleted - True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDeleted
```
public Boolean getDeleted()
```
    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
    
    Returns:
    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
  - getDocService
```
public ServiceEndpoint getDocService()
```
    The service endpoint for updating documents in a search domain.
    
    Returns:
    The service endpoint for updating documents in a search domain.
  - setDocService
```
public void setDocService(ServiceEndpoint docService)
```
    The service endpoint for updating documents in a search domain.
    
    Parameters:
    docService - The service endpoint for updating documents in a search domain.
  - withDocService
```
public DomainStatus withDocService(ServiceEndpoint docService)
```
    The service endpoint for updating documents in a search domain.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    docService - The service endpoint for updating documents in a search domain.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSearchService
```
public ServiceEndpoint getSearchService()
```
    The service endpoint for requesting search results from a search domain.
    
    Returns:
    The service endpoint for requesting search results from a search domain.
  - setSearchService
```
public void setSearchService(ServiceEndpoint searchService)
```
    The service endpoint for requesting search results from a search domain.
    
    Parameters:
    searchService - The service endpoint for requesting search results from a search domain.
  - withSearchService
```
public DomainStatus withSearchService(ServiceEndpoint searchService)
```
    The service endpoint for requesting search results from a search domain.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    searchService - The service endpoint for requesting search results from a search domain.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isRequiresIndexDocuments
```
public Boolean isRequiresIndexDocuments()
```
    True if IndexDocuments needs to be called to activate the current domain configuration.
    
    Returns:
    True if IndexDocuments needs to be called to activate the current domain configuration.
  - setRequiresIndexDocuments
```
public void setRequiresIndexDocuments(Boolean requiresIndexDocuments)
```
    True if IndexDocuments needs to be called to activate the current domain configuration.
    
    Parameters:
    requiresIndexDocuments - True if IndexDocuments needs to be called to activate the current domain configuration.
  - withRequiresIndexDocuments
```
public DomainStatus withRequiresIndexDocuments(Boolean requiresIndexDocuments)
```
    True if IndexDocuments needs to be called to activate the current domain configuration.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    requiresIndexDocuments - True if IndexDocuments needs to be called to activate the current domain configuration.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getRequiresIndexDocuments
```
public Boolean getRequiresIndexDocuments()
```
    True if IndexDocuments needs to be called to activate the current domain configuration.
    
    Returns:
    True if IndexDocuments needs to be called to activate the current domain configuration.
  - isProcessing
```
public Boolean isProcessing()
```
    True if processing is being done to activate the current domain configuration.
    
    Returns:
    True if processing is being done to activate the current domain configuration.
  - setProcessing
```
public void setProcessing(Boolean processing)
```
    True if processing is being done to activate the current domain configuration.
    
    Parameters:
    processing - True if processing is being done to activate the current domain configuration.
  - withProcessing
```
public DomainStatus withProcessing(Boolean processing)
```
    True if processing is being done to activate the current domain configuration.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    processing - True if processing is being done to activate the current domain configuration.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getProcessing
```
public Boolean getProcessing()
```
    True if processing is being done to activate the current domain configuration.
    
    Returns:
    True if processing is being done to activate the current domain configuration.
  - getSearchInstanceType
```
public String getSearchInstanceType()
```
    The instance type that is being used to process search requests.
    
    Returns:
    The instance type that is being used to process search requests.
  - setSearchInstanceType
```
public void setSearchInstanceType(String searchInstanceType)
```
    The instance type that is being used to process search requests.
    
    Parameters:
    searchInstanceType - The instance type that is being used to process search requests.
  - withSearchInstanceType
```
public DomainStatus withSearchInstanceType(String searchInstanceType)
```
    The instance type that is being used to process search requests.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    searchInstanceType - The instance type that is being used to process search requests.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSearchPartitionCount
```
public Integer getSearchPartitionCount()
```
    The number of partitions across which the search index is spread.
    Constraints:
    Range: 1 -
    
    Returns:
    The number of partitions across which the search index is spread.
  - setSearchPartitionCount
```
public void setSearchPartitionCount(Integer searchPartitionCount)
```
    The number of partitions across which the search index is spread.
    Constraints:
    Range: 1 -
    
    Parameters:
    searchPartitionCount - The number of partitions across which the search index is spread.
  - withSearchPartitionCount
```
public DomainStatus withSearchPartitionCount(Integer searchPartitionCount)
```
    The number of partitions across which the search index is spread.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 -
    
    Parameters:
    searchPartitionCount - The number of partitions across which the search index is spread.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSearchInstanceCount
```
public Integer getSearchInstanceCount()
```
    The number of search instances that are available to process search requests.
    Constraints:
    Range: 1 -
    
    Returns:
    The number of search instances that are available to process search requests.
  - setSearchInstanceCount
```
public void setSearchInstanceCount(Integer searchInstanceCount)
```
    The number of search instances that are available to process search requests.
    Constraints:
    Range: 1 -
    
    Parameters:
    searchInstanceCount - The number of search instances that are available to process search requests.
  - withSearchInstanceCount
```
public DomainStatus withSearchInstanceCount(Integer searchInstanceCount)
```
    The number of search instances that are available to process search requests.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 -
    
    Parameters:
    searchInstanceCount - The number of search instances that are available to process search requests.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class DomainStatus

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainStatus

Method Detail

getDomainId

setDomainId

withDomainId

getDomainName

setDomainName

withDomainName

getARN

setARN

withARN

isCreated

setCreated

withCreated

getCreated

isDeleted

setDeleted

withDeleted

getDeleted

getDocService

setDocService

withDocService

getSearchService

setSearchService

withSearchService

isRequiresIndexDocuments

setRequiresIndexDocuments

withRequiresIndexDocuments

getRequiresIndexDocuments

isProcessing

setProcessing

withProcessing

getProcessing

getSearchInstanceType

setSearchInstanceType

withSearchInstanceType

getSearchPartitionCount

setSearchPartitionCount

withSearchPartitionCount

getSearchInstanceCount

setSearchInstanceCount

withSearchInstanceCount

toString

hashCode

equals