Class ProspectingFromEngagementTaskSort

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

Specifies the sort configuration for ListProspectingFromEngagementTasks. Contains the field to sort by and the sort direction.

See Also:

  • Method Details

    • sortOrder

      public final SortOrder sortOrder()

      The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first.

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

      Returns:
      The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first.

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

      Returns:
      The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first.
      See Also:

    • sortBy

      public final ProspectingFromEngagementTaskSortName sortBy()

      The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements).

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

      Returns:
      The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements).
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements).

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

      Returns:
      The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements).
      See Also:

    • toBuilder

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

    • builder

      public static ProspectingFromEngagementTaskSort.Builder builder()

    • serializableBuilderClass

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