Class ListRecommendationsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.devopsagent.model.DevOpsAgentRequest
software.amazon.awssdk.services.devopsagent.model.ListRecommendationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListRecommendationsRequest.Builder,ListRecommendationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListRecommendationsRequest extends DevOpsAgentRequest implements ToCopyableBuilder<ListRecommendationsRequest.Builder,ListRecommendationsRequest>

Request structure for listing recommendations with filtering and pagination support

  • Method Details

    • agentSpaceId

      public final String agentSpaceId()

      The unique identifier for the agent space containing the recommendations

      Returns:
      The unique identifier for the agent space containing the recommendations

    • taskId

      public final String taskId()

      Optional task ID to filter recommendations by specific task

      Returns:
      Optional task ID to filter recommendations by specific task

    • goalId

      public final String goalId()

      Optional goal ID to filter recommendations by specific goal

      Returns:
      Optional goal ID to filter recommendations by specific goal

    • status

      public final RecommendationStatus status()

      Optional status to filter recommendations by their current status

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

      Returns:
      Optional status to filter recommendations by their current status
      See Also:

    • statusAsString

      public final String statusAsString()

      Optional status to filter recommendations by their current status

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

      Returns:
      Optional status to filter recommendations by their current status
      See Also:

    • priority

      public final RecommendationPriority priority()

      Optional priority to filter recommendations by priority level

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

      Returns:
      Optional priority to filter recommendations by priority level
      See Also:

    • priorityAsString

      public final String priorityAsString()

      Optional priority to filter recommendations by priority level

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

      Returns:
      Optional priority to filter recommendations by priority level
      See Also:

    • limit

      public final Integer limit()

      Maximum number of recommendations to return in a single response

      Returns:
      Maximum number of recommendations to return in a single response

    • nextToken

      public final String nextToken()

      Token for retrieving the next page of results

      Returns:
      Token for retrieving the next page of results

    • toBuilder

      public ListRecommendationsRequest.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<ListRecommendationsRequest.Builder,ListRecommendationsRequest>
      Specified by:
      toBuilder in class DevOpsAgentRequest
      Returns:
      a builder for type T

    • builder

      public static ListRecommendationsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListRecommendationsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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