software.amazon.awssdk.services.sagemaker.model

Class ListWorkteamsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListWorkteamsRequest.Builder,ListWorkteamsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListWorkteamsRequest
extends SageMakerRequest
implements ToCopyableBuilder<ListWorkteamsRequest.Builder,ListWorkteamsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListWorkteamsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListWorkteamsRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of work teams to return in each page of the response.
String	nameContains() A string in the work team's name.
String	nextToken() If the result of the previous ListWorkteams request was truncated, the response includes a NextToken.
List<SdkField<?>>	sdkFields()
static Class<? extends ListWorkteamsRequest.Builder>	serializableBuilderClass()
ListWorkteamsSortByOptions	sortBy() The field to sort results by.
String	sortByAsString() The field to sort results by.
SortOrder	sortOrder() The sort order for results.
String	sortOrderAsString() The sort order for results.
ListWorkteamsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sortBy

public ListWorkteamsSortByOptions sortBy()

The field to sort results by. The default is CreationTime.

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

Returns:

The field to sort results by. The default is CreationTime.

See Also:

ListWorkteamsSortByOptions

sortByAsString

public String sortByAsString()

The field to sort results by. The default is CreationTime.

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

Returns:

The field to sort results by. The default is CreationTime.

See Also:

ListWorkteamsSortByOptions

sortOrder

public SortOrder sortOrder()

The sort order for results. The default is Ascending.

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 sort order for results. The default is Ascending.

See Also:

SortOrder

sortOrderAsString

public String sortOrderAsString()

The sort order for results. The default is Ascending.

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 sort order for results. The default is Ascending.

See Also:

SortOrder

nameContains

public String nameContains()

A string in the work team's name. This filter returns only work teams whose name contains the specified string.

Returns:

A string in the work team's name. This filter returns only work teams whose name contains the specified string.

nextToken

public String nextToken()

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

Returns:

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

maxResults

public Integer maxResults()

The maximum number of work teams to return in each page of the response.

Returns:

The maximum number of work teams to return in each page of the response.

toBuilder

public ListWorkteamsRequest.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<ListWorkteamsRequest.Builder,ListWorkteamsRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static ListWorkteamsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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