Class ListWorkforcesRequest

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

  • Method Details

    • sortBy

      public final ListWorkforcesSortByOptions sortBy()

      Sort workforces using the workforce name or creation date.

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

      Returns:
      Sort workforces using the workforce name or creation date.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      Sort workforces using the workforce name or creation date.

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

      Returns:
      Sort workforces using the workforce name or creation date.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      Sort workforces in ascending or descending order.

      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:
      Sort workforces in ascending or descending order.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      Sort workforces in ascending or descending order.

      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:
      Sort workforces in ascending or descending order.
      See Also:

    • nameContains

      public final String nameContains()

      A filter you can use to search for workforces using part of the workforce name.

      Returns:
      A filter you can use to search for workforces using part of the workforce name.

    • nextToken

      public final String nextToken()

      A token to resume pagination.

      Returns:
      A token to resume pagination.

    • maxResults

      public final Integer maxResults()

      The maximum number of workforces returned in the response.

      Returns:
      The maximum number of workforces returned in the response.

    • toBuilder

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

    • builder

      public static ListWorkforcesRequest.Builder builder()

    • serializableBuilderClass

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