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

Class ListCandidatesForAutoMlJobRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCandidatesForAutoMlJobRequest.Builder,ListCandidatesForAutoMlJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCandidatesForAutoMlJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	autoMLJobName()	List the candidates created for the job by providing the job's name.
static ListCandidatesForAutoMlJobRequest.Builder	builder()
String	candidateNameEquals()	List the candidates for the job and filter by candidate name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	List the job's candidates up to a specified limit.
String	nextToken()	If the previous response was truncated, you receive this token.
List<SdkField<?>>	sdkFields()
static Class<? extends ListCandidatesForAutoMlJobRequest.Builder>	serializableBuilderClass()
CandidateSortBy	sortBy()	The parameter by which to sort the results.
String	sortByAsString()	The parameter by which to sort the results.
AutoMLSortOrder	sortOrder()	The sort order for the results.
String	sortOrderAsString()	The sort order for the results.
CandidateStatus	statusEquals()	List the candidates for the job and filter by status.
String	statusEqualsAsString()	List the candidates for the job and filter by status.
ListCandidatesForAutoMlJobRequest.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

autoMLJobName

public final String autoMLJobName()

List the candidates created for the job by providing the job's name.

Returns:

List the candidates created for the job by providing the job's name.

statusEquals

public final CandidateStatus statusEquals()

List the candidates for the job and filter by status.

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

Returns:

List the candidates for the job and filter by status.

See Also:

CandidateStatus

statusEqualsAsString

public final String statusEqualsAsString()

List the candidates for the job and filter by status.

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

Returns:

List the candidates for the job and filter by status.

See Also:

CandidateStatus

candidateNameEquals

public final String candidateNameEquals()

List the candidates for the job and filter by candidate name.

Returns:

List the candidates for the job and filter by candidate name.

sortOrder

public final AutoMLSortOrder 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 AutoMLSortOrder.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:

AutoMLSortOrder

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

AutoMLSortOrder

sortBy

public final CandidateSortBy sortBy()

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

If the service returns an enum value that is not available in the current SDK version, sortBy will return CandidateSortBy.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 Descending.

See Also:

CandidateSortBy

sortByAsString

public final String sortByAsString()

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

If the service returns an enum value that is not available in the current SDK version, sortBy will return CandidateSortBy.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 Descending.

See Also:

CandidateSortBy

maxResults

public final Integer maxResults()

List the job's candidates up to a specified limit.

Returns:

List the job's candidates up to a specified limit.

nextToken

public final String nextToken()

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

Returns:

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

toBuilder

public ListCandidatesForAutoMlJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCandidatesForAutoMlJobRequest.Builder,ListCandidatesForAutoMlJobRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListCandidatesForAutoMlJobRequest.Builder builder()

serializableBuilderClass

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