Class FeatureMetadata

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

The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

See Also:

  • Method Details

    • status

      public final FeatureStatus status()

      The status of the feature on the DB instance. Possible values include the following:

      • ENABLED - The feature is enabled on the instance.

      • DISABLED - The feature is disabled on the instance.

      • UNSUPPORTED - The feature isn't supported on the instance.

      • ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires a reboot to take effect.

      • DISABLED_PENDING_REBOOT - The feature is disabled on the instance but requires a reboot to take effect.

      • UNKNOWN - The feature status couldn't be determined.

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

      Returns:
      The status of the feature on the DB instance. Possible values include the following:

      • ENABLED - The feature is enabled on the instance.

      • DISABLED - The feature is disabled on the instance.

      • UNSUPPORTED - The feature isn't supported on the instance.

      • ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires a reboot to take effect.

      • DISABLED_PENDING_REBOOT - The feature is disabled on the instance but requires a reboot to take effect.

      • UNKNOWN - The feature status couldn't be determined.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the feature on the DB instance. Possible values include the following:

      • ENABLED - The feature is enabled on the instance.

      • DISABLED - The feature is disabled on the instance.

      • UNSUPPORTED - The feature isn't supported on the instance.

      • ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires a reboot to take effect.

      • DISABLED_PENDING_REBOOT - The feature is disabled on the instance but requires a reboot to take effect.

      • UNKNOWN - The feature status couldn't be determined.

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

      Returns:
      The status of the feature on the DB instance. Possible values include the following:

      • ENABLED - The feature is enabled on the instance.

      • DISABLED - The feature is disabled on the instance.

      • UNSUPPORTED - The feature isn't supported on the instance.

      • ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires a reboot to take effect.

      • DISABLED_PENDING_REBOOT - The feature is disabled on the instance but requires a reboot to take effect.

      • UNKNOWN - The feature status couldn't be determined.

      See Also:

    • toBuilder

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

    • builder

      public static FeatureMetadata.Builder builder()

    • serializableBuilderClass

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