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

Class ListModelPackagesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListModelPackagesRequest.Builder,ListModelPackagesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListModelPackagesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListModelPackagesRequest.Builder	builder()
Instant	creationTimeAfter()	A filter that returns only model packages created after the specified time (timestamp).
Instant	creationTimeBefore()	A filter that returns only model packages created before the specified time (timestamp).
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 model packages to return in the response.
ModelApprovalStatus	modelApprovalStatus()	A filter that returns only the model packages with the specified approval status.
String	modelApprovalStatusAsString()	A filter that returns only the model packages with the specified approval status.
String	modelPackageGroupName()	A filter that returns only model versions that belong to the specified model group.
ModelPackageType	modelPackageType()	A filter that returns only the model packages of the specified type.
String	modelPackageTypeAsString()	A filter that returns only the model packages of the specified type.
String	nameContains()	A string in the model package name.
String	nextToken()	If the response to a previous ListModelPackages request was truncated, the response includes a NextToken.
List<SdkField<?>>	sdkFields()
static Class<? extends ListModelPackagesRequest.Builder>	serializableBuilderClass()
ModelPackageSortBy	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.
ListModelPackagesRequest.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

creationTimeAfter

public final Instant creationTimeAfter()

A filter that returns only model packages created after the specified time (timestamp).

Returns:

A filter that returns only model packages created after the specified time (timestamp).

creationTimeBefore

public final Instant creationTimeBefore()

A filter that returns only model packages created before the specified time (timestamp).

Returns:

A filter that returns only model packages created before the specified time (timestamp).

maxResults

public final Integer maxResults()

The maximum number of model packages to return in the response.

Returns:

The maximum number of model packages to return in the response.

nameContains

public final String nameContains()

A string in the model package name. This filter returns only model packages whose name contains the specified string.

Returns:

A string in the model package name. This filter returns only model packages whose name contains the specified string.

modelApprovalStatus

public final ModelApprovalStatus modelApprovalStatus()

A filter that returns only the model packages with the specified approval status.

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

Returns:

A filter that returns only the model packages with the specified approval status.

See Also:

ModelApprovalStatus

modelApprovalStatusAsString

public final String modelApprovalStatusAsString()

A filter that returns only the model packages with the specified approval status.

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

Returns:

A filter that returns only the model packages with the specified approval status.

See Also:

ModelApprovalStatus

modelPackageGroupName

public final String modelPackageGroupName()

A filter that returns only model versions that belong to the specified model group.

Returns:

A filter that returns only model versions that belong to the specified model group.

modelPackageType

public final ModelPackageType modelPackageType()

A filter that returns only the model packages of the specified type. This can be one of the following values.

• UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

• VERSIONED - List only versioned models.

• BOTH - List both versioned and unversioned models.

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

Returns:

A filter that returns only the model packages of the specified type. This can be one of the following values.

• UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

• VERSIONED - List only versioned models.

• BOTH - List both versioned and unversioned models.

See Also:

ModelPackageType

modelPackageTypeAsString

public final String modelPackageTypeAsString()

A filter that returns only the model packages of the specified type. This can be one of the following values.

• UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

• VERSIONED - List only versioned models.

• BOTH - List both versioned and unversioned models.

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

Returns:

A filter that returns only the model packages of the specified type. This can be one of the following values.

• UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

• VERSIONED - List only versioned models.

• BOTH - List both versioned and unversioned models.

See Also:

ModelPackageType

nextToken

public final String nextToken()

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

Returns:

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

sortBy

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

ModelPackageSortBy

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

ModelPackageSortBy

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

toBuilder

public ListModelPackagesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListModelPackagesRequest.Builder,ListModelPackagesRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListModelPackagesRequest.Builder builder()

serializableBuilderClass

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