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

Class ListUserProfilesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListUserProfilesRequest.Builder,ListUserProfilesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListUserProfilesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListUserProfilesRequest.Builder	builder()
String	domainIdEquals()	A parameter by which to filter the results.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The total number of items to return in the response.
String	nextToken()	If the previous response was truncated, you will receive this token.
List<SdkField<?>>	sdkFields()
static Class<? extends ListUserProfilesRequest.Builder>	serializableBuilderClass()
UserProfileSortKey	sortBy()	The parameter by which to sort the results.
String	sortByAsString()	The parameter by which to sort the results.
SortOrder	sortOrder()	The sort order for the results.
String	sortOrderAsString()	The sort order for the results.
ListUserProfilesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userProfileNameContains()	A parameter by which to filter the results.

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

nextToken

public final String nextToken()

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Returns:

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

maxResults

public final Integer maxResults()

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

Returns:

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

sortOrder

public final SortOrder sortOrder()

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

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

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

See Also:

SortOrder

sortBy

public final UserProfileSortKey sortBy()

The parameter by which to sort the results. The default is CreationTime.

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

Returns:

The parameter by which to sort the results. The default is CreationTime.

See Also:

UserProfileSortKey

sortByAsString

public final String sortByAsString()

The parameter by which to sort the results. The default is CreationTime.

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

Returns:

The parameter by which to sort the results. The default is CreationTime.

See Also:

UserProfileSortKey

domainIdEquals

public final String domainIdEquals()

A parameter by which to filter the results.

Returns:

A parameter by which to filter the results.

userProfileNameContains

public final String userProfileNameContains()

A parameter by which to filter the results.

Returns:

A parameter by which to filter the results.

toBuilder

public ListUserProfilesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListUserProfilesRequest.Builder,ListUserProfilesRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListUserProfilesRequest.Builder builder()

serializableBuilderClass

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