Class AwsOpenSearchServiceDomainDetails

    • Method Detail

      • arn

        public final String arn()

        The ARN of the OpenSearch Service domain.

        Returns:
        The ARN of the OpenSearch Service domain.
      • accessPolicies

        public final String accessPolicies()

        IAM policy document that specifies the access policies for the OpenSearch Service domain.

        Returns:
        IAM policy document that specifies the access policies for the OpenSearch Service domain.
      • domainName

        public final String domainName()

        The name of the endpoint.

        Returns:
        The name of the endpoint.
      • id

        public final String id()

        The identifier of the domain.

        Returns:
        The identifier of the domain.
      • domainEndpoint

        public final String domainEndpoint()

        The domain endpoint.

        Returns:
        The domain endpoint.
      • engineVersion

        public final String engineVersion()

        The version of the domain engine.

        Returns:
        The version of the domain engine.
      • serviceSoftwareOptions

        public final AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails serviceSoftwareOptions()

        Information about the status of a domain relative to the latest service software.

        Returns:
        Information about the status of a domain relative to the latest service software.
      • vpcOptions

        public final AwsOpenSearchServiceDomainVpcOptionsDetails vpcOptions()

        Information that OpenSearch Service derives based on VPCOptions for the domain.

        Returns:
        Information that OpenSearch Service derives based on VPCOptions for the domain.
      • hasDomainEndpoints

        public final boolean hasDomainEndpoints()
        For responses, this returns true if the service returned a value for the DomainEndpoints 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.
      • domainEndpoints

        public final Map<String,​String> domainEndpoints()

        The domain endpoints. Used if the OpenSearch domain resides in a VPC.

        This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

        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 hasDomainEndpoints() method.

        Returns:
        The domain endpoints. Used if the OpenSearch domain resides in a VPC.

        This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

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