Class DomainStatus

java.lang.Object
software.amazon.awssdk.services.cloudsearch.model.DomainStatus
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DomainStatus.Builder,DomainStatus>
@Generated("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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DomainStatus.Builder,DomainStatus>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.