Class PackageConfiguration

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

The configuration parameters for a package.

See Also:

  • Method Details

    • licenseRequirement

      public final RequirementLevel licenseRequirement()

      The license requirements for the package.

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

      Returns:
      The license requirements for the package.
      See Also:

    • licenseRequirementAsString

      public final String licenseRequirementAsString()

      The license requirements for the package.

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

      Returns:
      The license requirements for the package.
      See Also:

    • licenseFilepath

      public final String licenseFilepath()

      The relative file path for the license associated with the package.

      Returns:
      The relative file path for the license associated with the package.

    • configurationRequirement

      public final RequirementLevel configurationRequirement()

      The configuration requirements for the package.

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

      Returns:
      The configuration requirements for the package.
      See Also:

    • configurationRequirementAsString

      public final String configurationRequirementAsString()

      The configuration requirements for the package.

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

      Returns:
      The configuration requirements for the package.
      See Also:

    • requiresRestartForConfigurationUpdate

      public final Boolean requiresRestartForConfigurationUpdate()

      This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.

      Returns:
      This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.

    • toBuilder

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

    • builder

      public static PackageConfiguration.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.