Class DomainStatus
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DomainStatus.Builder,
DomainStatus>
The current status of an OpenSearch Service domain.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Identity and Access Management (IAM) policy document specifying the access policies for the domain.Key-value pairs that specify advanced configuration options.final AdvancedSecurityOptions
Settings for fine-grained access control.final String
arn()
The Amazon Resource Name (ARN) of the domain.final AutoTuneOptionsOutput
Auto-Tune settings for the domain.static DomainStatus.Builder
builder()
final ChangeProgressDetails
Information about a configuration change happening on the domain.final ClusterConfig
Container for the cluster configuration of the domain.final CognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.final Boolean
created()
Creation status of an OpenSearch Service domain.final Boolean
deleted()
Deletion status of an OpenSearch Service domain.final DomainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.final String
domainId()
Unique identifier for the domain.final String
Name of the domain.The status of any changes that are currently in progress for the domain.final String
The status of any changes that are currently in progress for the domain.final EBSOptions
Container for EBS-based storage settings for the domain.final EncryptionAtRestOptions
Encryption at rest settings for the domain.final String
endpoint()
Domain-specific endpoint used to submit index, search, and data upload requests to the domain.The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.final String
IfIPAddressType
to set todualstack
, a version 2 domain endpoint is provisioned.final String
Version of OpenSearch or Elasticsearch that the domain is running, in the formatElasticsearch_X.Y
orOpenSearch_X.Y
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdvancedOptions property.final boolean
For responses, this returns true if the service returned a value for the Endpoints property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LogPublishingOptions property.final boolean
For responses, this returns true if the service returned a value for the ModifyingProperties property.final IPAddressType
The type of IP addresses supported by the endpoint for the domain.final String
The type of IP addresses supported by the endpoint for the domain.final Map
<LogType, LogPublishingOption> Log publishing options for the domain.final Map
<String, LogPublishingOption> Log publishing options for the domain.final List
<ModifyingProperties> Information about the domain properties that are currently being modified.Whether node-to-node encryption is enabled or disabled.final OffPeakWindowOptions
Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.final Boolean
The status of the domain configuration.static Class
<? extends DomainStatus.Builder> final ServiceSoftwareOptions
The current status of the domain's service software.final SnapshotOptions
DEPRECATED.final SoftwareUpdateOptions
Service software update options for the domain.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch.final VPCDerivedInfo
The VPC configuration for the domain.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainId
Unique identifier for the domain.
- Returns:
- Unique identifier for the domain.
-
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
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
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
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
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
If
IPAddressType
to set todualstack
, 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 todualstack
, 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 theisEmpty()
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
The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example
key, value
:'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
.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. Example
key, value
:'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
.
-
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
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
Version of OpenSearch or Elasticsearch that the domain is running, in the format
Elasticsearch_X.Y
orOpenSearch_X.Y
.- Returns:
- Version of OpenSearch or Elasticsearch that the domain is running, in the format
Elasticsearch_X.Y
orOpenSearch_X.Y
.
-
clusterConfig
Container for the cluster configuration of the domain.
- Returns:
- Container for the cluster configuration of the domain.
-
ebsOptions
Container for EBS-based storage settings for the domain.
- Returns:
- Container for EBS-based storage settings for the domain.
-
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
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 returnIPAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The type of IP addresses supported by the endpoint for the domain.
- See Also:
-
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 returnIPAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The type of IP addresses supported by the endpoint for the domain.
- See Also:
-
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
The VPC configuration for the domain.
- Returns:
- The VPC configuration for the domain.
-
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
Encryption at rest settings for the domain.
- Returns:
- Encryption at rest settings for the domain.
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
The current status of the domain's service software.
- Returns:
- The current status of the domain's service software.
-
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
Settings for fine-grained access control.
- Returns:
- Settings for fine-grained access control.
-
autoTuneOptions
Auto-Tune settings for the domain.
- Returns:
- Auto-Tune settings for the domain.
-
changeProgressDetails
Information about a configuration change happening on the domain.
- Returns:
- Information about a configuration change happening on the domain.
-
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
Service software update options for the domain.
- Returns:
- Service software update options for the domain.
-
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 returnDomainProcessingStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainProcessingStatusAsString()
.- Returns:
- The status of any changes that are currently in progress for the domain.
- See Also:
-
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 returnDomainProcessingStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainProcessingStatusAsString()
.- 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 theisEmpty()
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
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.
-
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 interfaceToCopyableBuilder<DomainStatus.Builder,
DomainStatus> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-