software.amazon.awssdk.services.cloudsearch.model

Class DomainStatus

java.lang.Object

software.amazon.awssdk.services.cloudsearch.model.DomainStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DomainStatus.Builder,DomainStatus>

@Generated(value="software.amazon.awssdk:codegen")
public final class DomainStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DomainStatus.Builder,DomainStatus>

The current status of the search domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DomainStatus.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Returns the value of the ARN property for this object.
static DomainStatus.Builder	builder()
Boolean	created() True if the search domain is created.
Boolean	deleted() True if the search domain has been deleted.
ServiceEndpoint	docService() The service endpoint for updating documents in a search domain.
String	domainId() Returns the value of the DomainId property for this object.
String	domainName() Returns the value of the DomainName property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Limits	limits() Returns the value of the Limits property for this object.
Boolean	processing() True if processing is being done to activate the current domain configuration.
Boolean	requiresIndexDocuments() True if IndexDocuments needs to be called to activate the current domain configuration.
List<SdkField<?>>	sdkFields()
Integer	searchInstanceCount() The number of search instances that are available to process search requests.
String	searchInstanceType() The instance type that is being used to process search requests.
Integer	searchPartitionCount() The number of partitions across which the search index is spread.
ServiceEndpoint	searchService() The service endpoint for requesting search results from a search domain.
static Class<? extends DomainStatus.Builder>	serializableBuilderClass()
DomainStatus.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainId

public final String domainId()

Returns the value of the DomainId property for this object.

Returns:

The value of the DomainId property for this object.

domainName

public final String domainName()

Returns the value of the DomainName property for this object.

Returns:

The value of the DomainName property for this object.

arn

public final String arn()

Returns the value of the ARN property for this object.

Returns:

The value of the ARN property for this object.

created

public final 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:

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.

deleted

public final 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:

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.

docService

public final ServiceEndpoint docService()

The service endpoint for updating documents in a search domain.

Returns:

The service endpoint for updating documents in a search domain.

searchService

public final ServiceEndpoint searchService()

The service endpoint for requesting search results from a search domain.

Returns:

The service endpoint for requesting search results from a search domain.

requiresIndexDocuments

public final Boolean requiresIndexDocuments()

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.

processing

public final Boolean processing()

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.

searchInstanceType

public final String searchInstanceType()

The instance type that is being used to process search requests.

Returns:

The instance type that is being used to process search requests.

searchPartitionCount

public final Integer searchPartitionCount()

The number of partitions across which the search index is spread.

Returns:

The number of partitions across which the search index is spread.

searchInstanceCount

public final Integer searchInstanceCount()

The number of search instances that are available to process search requests.

Returns:

The number of search instances that are available to process search requests.

limits

public final Limits limits()

Returns the value of the Limits property for this object.

Returns:

The value of the Limits property for this object.

toBuilder

public DomainStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DomainStatus.Builder,DomainStatus>

builder

public static DomainStatus.Builder builder()

serializableBuilderClass

public static Class<? extends DomainStatus.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo