Class DomainStatus

java.lang.Object
software.amazon.awssdk.services.opensearch.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 an OpenSearch Service domain.

See Also:

  • Method Details

    • domainId

      public final String domainId()

      Unique identifier for the domain.

      Returns:
      Unique identifier for the domain.

    • domainName

      public final String domainName()

      Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

      Returns:
      Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

    • created

      public final Boolean created()

      Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

      Returns:
      Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

    • deleted

      public final Boolean deleted()

      Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

      Returns:
      Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

    • endpoint

      public final String endpoint()

      Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

      Returns:
      Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

    • endpointV2

      public final String endpointV2()

      If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

      Returns:
      If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

    • hasEndpoints

      public final boolean hasEndpoints()
      For responses, this returns true if the service returned a value for the Endpoints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • endpoints

      public final Map<String,String> endpoints()

      The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

      • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

      • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEndpoints() method.

      Returns:
      The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

      • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

      • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

    • domainEndpointV2HostedZoneId

      public final String domainEndpointV2HostedZoneId()

      The dual stack hosted zone ID for the domain.

      Returns:
      The dual stack hosted zone ID for the domain.

    • processing

      public final Boolean processing()

      The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

      Returns:
      The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

    • upgradeProcessing

      public final Boolean upgradeProcessing()

      The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

      Returns:
      The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

    • engineVersion

      public final String engineVersion()

      Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

      Returns:
      Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

    • clusterConfig

      public final ClusterConfig clusterConfig()

      Container for the cluster configuration of the domain.

      Returns:
      Container for the cluster configuration of the domain.

    • ebsOptions

      public final EBSOptions ebsOptions()

      Container for EBS-based storage settings for the domain.

      Returns:
      Container for EBS-based storage settings for the domain.

    • accessPolicies

      public final String accessPolicies()

      Identity and Access Management (IAM) policy document specifying the access policies for the domain.

      Returns:
      Identity and Access Management (IAM) policy document specifying the access policies for the domain.

    • ipAddressType

      public final IPAddressType ipAddressType()

      The type of IP addresses supported by the endpoint for the domain.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IPAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The type of IP addresses supported by the endpoint for the domain.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The type of IP addresses supported by the endpoint for the domain.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IPAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The type of IP addresses supported by the endpoint for the domain.
      See Also:

    • snapshotOptions

      public final SnapshotOptions snapshotOptions()

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      Returns:
      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

    • vpcOptions

      public final VPCDerivedInfo vpcOptions()

      The VPC configuration for the domain.

      Returns:
      The VPC configuration for the domain.

    • cognitoOptions

      public final CognitoOptions cognitoOptions()

      Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

      Returns:
      Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

    • encryptionAtRestOptions

      public final EncryptionAtRestOptions encryptionAtRestOptions()

      Encryption at rest settings for the domain.

      Returns:
      Encryption at rest settings for the domain.

    • nodeToNodeEncryptionOptions

      public final NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions()

      Whether node-to-node encryption is enabled or disabled.

      Returns:
      Whether node-to-node encryption is enabled or disabled.

    • hasAdvancedOptions

      public final boolean hasAdvancedOptions()
      For responses, this returns true if the service returned a value for the AdvancedOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • advancedOptions

      public final Map<String,String> advancedOptions()

      Key-value pairs that specify advanced configuration options.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdvancedOptions() method.

      Returns:
      Key-value pairs that specify advanced configuration options.

    • logPublishingOptions

      public final Map<LogType,LogPublishingOption> logPublishingOptions()

      Log publishing options for the domain.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogPublishingOptions() method.

      Returns:
      Log publishing options for the domain.

    • hasLogPublishingOptions

      public final boolean hasLogPublishingOptions()
      For responses, this returns true if the service returned a value for the LogPublishingOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • logPublishingOptionsAsStrings

      public final Map<String,LogPublishingOption> logPublishingOptionsAsStrings()

      Log publishing options for the domain.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogPublishingOptions() method.

      Returns:
      Log publishing options for the domain.

    • serviceSoftwareOptions

      public final ServiceSoftwareOptions serviceSoftwareOptions()

      The current status of the domain's service software.

      Returns:
      The current status of the domain's service software.

    • domainEndpointOptions

      public final DomainEndpointOptions domainEndpointOptions()

      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

      Returns:
      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

    • advancedSecurityOptions

      public final AdvancedSecurityOptions advancedSecurityOptions()

      Settings for fine-grained access control.

      Returns:
      Settings for fine-grained access control.

    • autoTuneOptions

      public final AutoTuneOptionsOutput autoTuneOptions()

      Auto-Tune settings for the domain.

      Returns:
      Auto-Tune settings for the domain.

    • changeProgressDetails

      public final ChangeProgressDetails changeProgressDetails()

      Information about a configuration change happening on the domain.

      Returns:
      Information about a configuration change happening on the domain.

    • offPeakWindowOptions

      public final OffPeakWindowOptions offPeakWindowOptions()

      Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

      Returns:
      Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

    • softwareUpdateOptions

      public final SoftwareUpdateOptions softwareUpdateOptions()

      Service software update options for the domain.

      Returns:
      Service software update options for the domain.

    • domainProcessingStatus

      public final DomainProcessingStatusType domainProcessingStatus()

      The status of any changes that are currently in progress for the domain.

      If the service returns an enum value that is not available in the current SDK version, domainProcessingStatus will return DomainProcessingStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainProcessingStatusAsString().

      Returns:
      The status of any changes that are currently in progress for the domain.
      See Also:

    • domainProcessingStatusAsString

      public final String domainProcessingStatusAsString()

      The status of any changes that are currently in progress for the domain.

      If the service returns an enum value that is not available in the current SDK version, domainProcessingStatus will return DomainProcessingStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainProcessingStatusAsString().

      Returns:
      The status of any changes that are currently in progress for the domain.
      See Also:

    • hasModifyingProperties

      public final boolean hasModifyingProperties()
      For responses, this returns true if the service returned a value for the ModifyingProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • modifyingProperties

      public final List<ModifyingProperties> modifyingProperties()

      Information about the domain properties that are currently being modified.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasModifyingProperties() method.

      Returns:
      Information about the domain properties that are currently being modified.

    • aimlOptions

      public final AIMLOptionsOutput aimlOptions()

      Container for parameters required to enable all machine learning features.

      Returns:
      Container for parameters required to enable all machine learning features.

    • 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.