Package software.amazon.awssdk.services.sagemaker.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListWorkforcesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListWorkforcesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of workforces returned in the response.
String	nameContains()	A filter you can use to search for workforces using part of the workforce name.
String	nextToken()	A token to resume pagination.
List<SdkField<?>>	sdkFields()
static Class<? extends ListWorkforcesRequest.Builder>	serializableBuilderClass()
ListWorkforcesSortByOptions	sortBy()	Sort workforces using the workforce name or creation date.
String	sortByAsString()	Sort workforces using the workforce name or creation date.
SortOrder	sortOrder()	Sort workforces in ascending or descending order.
String	sortOrderAsString()	Sort workforces in ascending or descending order.
ListWorkforcesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ListWorkforcesSortByOptions

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:

ListWorkforcesSortByOptions

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:

SortOrder

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:

SortOrder

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListWorkforcesRequest.Builder,ListWorkforcesRequest>

Specified by:

toBuilder in class SageMakerRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo