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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DomainStatus.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accessPolicies()`	Identity and Access Management (IAM) policy document specifying the access policies for the domain.
`Map<String,String>`	`advancedOptions()`	Key-value pairs that specify advanced configuration options.
`AdvancedSecurityOptions`	`advancedSecurityOptions()`	Settings for fine-grained access control.
`AIMLOptionsOutput`	`aimlOptions()`	Container for parameters required to enable all machine learning features.
`String`	`arn()`	The Amazon Resource Name (ARN) of the domain.
`AutoTuneOptionsOutput`	`autoTuneOptions()`	Auto-Tune settings for the domain.
`static DomainStatus.Builder`	`builder()`
`ChangeProgressDetails`	`changeProgressDetails()`	Information about a configuration change happening on the domain.
`ClusterConfig`	`clusterConfig()`	Container for the cluster configuration of the domain.
`CognitoOptions`	`cognitoOptions()`	Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
`Boolean`	`created()`	Creation status of an OpenSearch Service domain.
`Boolean`	`deleted()`	Deletion status of an OpenSearch Service domain.
`DomainEndpointOptions`	`domainEndpointOptions()`	Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
`String`	`domainEndpointV2HostedZoneId()`	The dual stack hosted zone ID for the domain.
`String`	`domainId()`	Unique identifier for the domain.
`String`	`domainName()`	Name of the domain.
`DomainProcessingStatusType`	`domainProcessingStatus()`	The status of any changes that are currently in progress for the domain.
`String`	`domainProcessingStatusAsString()`	The status of any changes that are currently in progress for the domain.
`EBSOptions`	`ebsOptions()`	Container for EBS-based storage settings for the domain.
`EncryptionAtRestOptions`	`encryptionAtRestOptions()`	Encryption at rest settings for the domain.
`String`	`endpoint()`	Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
`Map<String,String>`	`endpoints()`	The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.
`String`	`endpointV2()`	If `IPAddressType` to set to `dualstack`, a version 2 domain endpoint is provisioned.
`String`	`engineVersion()`	Version of OpenSearch or Elasticsearch that the domain is running, in the format `Elasticsearch_X.Y` or `OpenSearch_X.Y`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdvancedOptions()`	For responses, this returns true if the service returned a value for the AdvancedOptions property.
`boolean`	`hasEndpoints()`	For responses, this returns true if the service returned a value for the Endpoints property.
`int`	`hashCode()`
`boolean`	`hasLogPublishingOptions()`	For responses, this returns true if the service returned a value for the LogPublishingOptions property.
`boolean`	`hasModifyingProperties()`	For responses, this returns true if the service returned a value for the ModifyingProperties property.
`IPAddressType`	`ipAddressType()`	The type of IP addresses supported by the endpoint for the domain.
`String`	`ipAddressTypeAsString()`	The type of IP addresses supported by the endpoint for the domain.
`Map<LogType,LogPublishingOption>`	`logPublishingOptions()`	Log publishing options for the domain.
`Map<String,LogPublishingOption>`	`logPublishingOptionsAsStrings()`	Log publishing options for the domain.
`List<ModifyingProperties>`	`modifyingProperties()`	Information about the domain properties that are currently being modified.
`NodeToNodeEncryptionOptions`	`nodeToNodeEncryptionOptions()`	Whether node-to-node encryption is enabled or disabled.
`OffPeakWindowOptions`	`offPeakWindowOptions()`	Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
`Boolean`	`processing()`	The status of the domain configuration.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DomainStatus.Builder>`	`serializableBuilderClass()`
`ServiceSoftwareOptions`	`serviceSoftwareOptions()`	The current status of the domain's service software.
`SnapshotOptions`	`snapshotOptions()`	DEPRECATED.
`SoftwareUpdateOptions`	`softwareUpdateOptions()`	Service software update options for the domain.
`DomainStatus.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Boolean`	`upgradeProcessing()`	The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch.
`VPCDerivedInfo`	`vpcOptions()`	The VPC configuration for the domain.

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()
```
    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:
    
    IPAddressType
  - 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:
    
    IPAddressType
  - 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:
    
    DomainProcessingStatusType
  - 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:
    
    DomainProcessingStatusType
  - 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()
```
    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

Class DomainStatus

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

domainId

domainName

arn

created

deleted

endpoint

endpointV2

hasEndpoints

endpoints

domainEndpointV2HostedZoneId

processing

upgradeProcessing

engineVersion

clusterConfig

ebsOptions

accessPolicies

ipAddressType

ipAddressTypeAsString

snapshotOptions

vpcOptions

cognitoOptions

encryptionAtRestOptions

nodeToNodeEncryptionOptions

hasAdvancedOptions

advancedOptions

logPublishingOptions

hasLogPublishingOptions

logPublishingOptionsAsStrings

serviceSoftwareOptions

domainEndpointOptions

advancedSecurityOptions

autoTuneOptions

changeProgressDetails

offPeakWindowOptions

softwareUpdateOptions

domainProcessingStatus

domainProcessingStatusAsString

hasModifyingProperties

modifyingProperties

aimlOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields