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

Class ListAppsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAppsRequest.Builder,ListAppsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAppsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListAppsRequest.Builder	builder()
String	domainIdEquals()	A parameter to search for the domain ID.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	This parameter defines the maximum number of results that can be returned in a single response.
String	nextToken()	If the previous response was truncated, you will receive this token.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAppsRequest.Builder>	serializableBuilderClass()
AppSortKey	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.
String	spaceNameEquals()	A parameter to search by space name.
ListAppsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userProfileNameEquals()	A parameter to search by user profile name.

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

This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

Returns:

This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults 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 AppSortKey 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 AppSortKey.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:

AppSortKey

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 AppSortKey.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:

AppSortKey

domainIdEquals

public final String domainIdEquals()

A parameter to search for the domain ID.

Returns:

A parameter to search for the domain ID.

userProfileNameEquals

public final String userProfileNameEquals()

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

Returns:

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

spaceNameEquals

public final String spaceNameEquals()

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

Returns:

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

toBuilder

public ListAppsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAppsRequest.Builder,ListAppsRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListAppsRequest.Builder builder()

serializableBuilderClass

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