Package software.amazon.awssdk.services.opensearch.model

Class DomainPackageDetails

java.lang.Object
software.amazon.awssdk.services.opensearch.model.DomainPackageDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DomainPackageDetails.Builder,DomainPackageDetails>
@Generated("software.amazon.awssdk:codegen") public final class DomainPackageDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DomainPackageDetails.Builder,DomainPackageDetails>

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

See Also:

  • Method Details

    • packageID

      public final String packageID()

      Internal ID of the package.

      Returns:
      Internal ID of the package.

    • packageName

      public final String packageName()

      User-specified name of the package.

      Returns:
      User-specified name of the package.

    • packageType

      public final PackageType packageType()

      The type of package.

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

      Returns:
      The type of package.
      See Also:

    • packageTypeAsString

      public final String packageTypeAsString()

      The type of package.

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

      Returns:
      The type of package.
      See Also:

    • lastUpdated

      public final Instant lastUpdated()

      Timestamp of the most recent update to the package association status.

      Returns:
      Timestamp of the most recent update to the package association status.

    • domainName

      public final String domainName()

      Name of the domain that the package is associated with.

      Returns:
      Name of the domain that the package is associated with.

    • domainPackageStatus

      public final DomainPackageStatus domainPackageStatus()

      State of the association.

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

      Returns:
      State of the association.
      See Also:

    • domainPackageStatusAsString

      public final String domainPackageStatusAsString()

      State of the association.

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

      Returns:
      State of the association.
      See Also:

    • packageVersion

      public final String packageVersion()

      The current version of the package.

      Returns:
      The current version of the package.

    • referencePath

      public final String referencePath()

      The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

      Returns:
      The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

    • errorDetails

      public final ErrorDetails errorDetails()

      Additional information if the package is in an error state. Null otherwise.

      Returns:
      Additional information if the package is in an error state. Null otherwise.

    • toBuilder

      public DomainPackageDetails.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<DomainPackageDetails.Builder,DomainPackageDetails>
      Returns:
      a builder for type T

    • builder

      public static DomainPackageDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DomainPackageDetails.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.