Class PackageDetails

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

Basic information about a package.

See Also:

  • Method Details

    • packageID

      public final String packageID()

      The unique identifier of the package.

      Returns:
      The unique identifier of the package.

    • packageName

      public final String packageName()

      The user-specified name of the package.

      Returns:
      The 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:

    • packageDescription

      public final String packageDescription()

      User-specified description of the package.

      Returns:
      User-specified description of the package.

    • packageStatus

      public final PackageStatus packageStatus()

      The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

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

      Returns:
      The current status of the package. The available options are AVAILABLE, COPYING , COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING , and DELETE_FAILED.
      See Also:

    • packageStatusAsString

      public final String packageStatusAsString()

      The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

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

      Returns:
      The current status of the package. The available options are AVAILABLE, COPYING , COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING , and DELETE_FAILED.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the package was created.

      Returns:
      The timestamp when the package was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      Date and time when the package was last updated.

      Returns:
      Date and time when the package was last updated.

    • availablePackageVersion

      public final String availablePackageVersion()

      The package version.

      Returns:
      The package version.

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

    • engineVersion

      public final String engineVersion()

      Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

      Returns:
      Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

    • availablePluginProperties

      public final PluginProperties availablePluginProperties()

      If the package is a ZIP-PLUGIN package, additional information about plugin properties.

      Returns:
      If the package is a ZIP-PLUGIN package, additional information about plugin properties.

    • toBuilder

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

    • builder

      public static PackageDetails.Builder builder()

    • serializableBuilderClass

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