Package software.amazon.awssdk.services.elasticsearch.model

Class ElasticsearchDomainStatus

    • Method Detail

      • domainId

        public final String domainId()

        The unique identifier for the specified Elasticsearch domain.

        Returns:
        The unique identifier for the specified Elasticsearch domain.

      • domainName

        public final String domainName()

        The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        Returns:
        The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      • arn

        public final String arn()

        The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

        Returns:
        The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

      • created

        public final Boolean created()

        The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

        Returns:
        The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

      • deleted

        public final Boolean deleted()

        The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

        Returns:
        The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

      • endpoint

        public final String endpoint()

        The Elasticsearch domain endpoint that you use to submit index and search requests.

        Returns:
        The Elasticsearch domain endpoint that you use to submit index and search requests.

      • 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()

        Map containing the Elasticsearch domain endpoints used to submit index and search requests. 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:
        Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

      • processing

        public final Boolean processing()

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

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

      • upgradeProcessing

        public final Boolean upgradeProcessing()

        The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

        Returns:
        The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

      • elasticsearchVersion

        public final String elasticsearchVersion()
        Returns the value of the ElasticsearchVersion property for this object.
        Returns:
        The value of the ElasticsearchVersion property for this object.

      • elasticsearchClusterConfig

        public final ElasticsearchClusterConfig elasticsearchClusterConfig()

        The type and number of instances in the domain cluster.

        Returns:
        The type and number of instances in the domain cluster.

      • accessPolicies

        public final String accessPolicies()

        IAM access policy as a JSON-formatted string.

        Returns:
        IAM access policy as a JSON-formatted string.

      • snapshotOptions

        public final SnapshotOptions snapshotOptions()

        Specifies the status of the SnapshotOptions

        Returns:
        Specifies the status of the SnapshotOptions

      • encryptionAtRestOptions

        public final EncryptionAtRestOptions encryptionAtRestOptions()

        Specifies the status of the EncryptionAtRestOptions.

        Returns:
        Specifies the status of the EncryptionAtRestOptions.

      • nodeToNodeEncryptionOptions

        public final NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions()

        Specifies the status of the NodeToNodeEncryptionOptions.

        Returns:
        Specifies the status of the NodeToNodeEncryptionOptions.

      • 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()

        Specifies the status of the AdvancedOptions

        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:
        Specifies the status of the AdvancedOptions

      • logPublishingOptions

        public final Map<LogType,​LogPublishingOption> logPublishingOptions()

        Log publishing options for the given 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 given 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 given 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 given domain.

      • serviceSoftwareOptions

        public final ServiceSoftwareOptions serviceSoftwareOptions()

        The current status of the Elasticsearch domain's service software.

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

      • domainEndpointOptions

        public final DomainEndpointOptions domainEndpointOptions()

        The current status of the Elasticsearch domain's endpoint options.

        Returns:
        The current status of the Elasticsearch domain's endpoint options.

      • advancedSecurityOptions

        public final AdvancedSecurityOptions advancedSecurityOptions()

        The current status of the Elasticsearch domain's advanced security options.

        Returns:
        The current status of the Elasticsearch domain's advanced security options.

      • autoTuneOptions

        public final AutoTuneOptionsOutput autoTuneOptions()

        The current status of the Elasticsearch domain's Auto-Tune options.

        Returns:
        The current status of the Elasticsearch domain's Auto-Tune options.

      • changeProgressDetails

        public final ChangeProgressDetails changeProgressDetails()

        Specifies change details of the domain configuration change.

        Returns:
        Specifies change details of the domain configuration change.

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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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