Class RecommendedAction

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

Describes a specific recommended action.

See Also:

  • Method Details

    • id

      public final String id()

      The ID for the recommended action.

      Returns:
      The ID for the recommended action.

    • type

      public final ActionType type()

      The type of action you can take by adopting the recommended action.

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

      Returns:
      The type of action you can take by adopting the recommended action.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of action you can take by adopting the recommended action.

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

      Returns:
      The type of action you can take by adopting the recommended action.
      See Also:

    • accountId

      public final String accountId()

      The account that the recommended action is for.

      Returns:
      The account that the recommended action is for.

    • severity

      public final Severity severity()

      The severity associated with the recommended action.

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

      Returns:
      The severity associated with the recommended action.
      See Also:

    • severityAsString

      public final String severityAsString()

      The severity associated with the recommended action.

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

      Returns:
      The severity associated with the recommended action.
      See Also:

    • feature

      public final Feature feature()

      The feature associated with the recommended action.

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

      Returns:
      The feature associated with the recommended action.
      See Also:

    • featureAsString

      public final String featureAsString()

      The feature associated with the recommended action.

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

      Returns:
      The feature associated with the recommended action.
      See Also:

    • hasContext

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

    • context

      public final Map<String,String> context()

      Context that applies to the recommended action.

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

      Returns:
      Context that applies to the recommended action.

    • hasNextSteps

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

    • nextSteps

      public final List<String> nextSteps()

      The possible next steps to execute the recommended action.

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

      Returns:
      The possible next steps to execute the recommended action.

    • lastUpdatedTimeStamp

      public final String lastUpdatedTimeStamp()

      The time when the recommended action status was last updated.

      Returns:
      The time when the recommended action status was last updated.

    • toBuilder

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

    • builder

      public static RecommendedAction.Builder builder()

    • serializableBuilderClass

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