Package software.amazon.awssdk.services.bedrock.model

Class ListCustomModelsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrock.model.BedrockRequest

software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCustomModelsRequest.Builder,ListCustomModelsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCustomModelsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	baseModelArnEquals()	Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
static ListCustomModelsRequest.Builder	builder()
Instant	creationTimeAfter()	Return custom models created after the specified time.
Instant	creationTimeBefore()	Return custom models created before the specified time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	foundationModelArnEquals()	Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isOwned()	Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).
Integer	maxResults()	The maximum number of results to return in the response.
ModelStatus	modelStatus()	The status of them model to filter results by.
String	modelStatusAsString()	The status of them model to filter results by.
String	nameContains()	Return custom models only if the job name contains these characters.
String	nextToken()	If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListCustomModelsRequest.Builder>	serializableBuilderClass()
SortModelsBy	sortBy()	The field to sort by in the returned list of models.
String	sortByAsString()	The field to sort by in the returned list of models.
SortOrder	sortOrder()	The sort order of the results.
String	sortOrderAsString()	The sort order of the results.
ListCustomModelsRequest.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

creationTimeBefore

public final Instant creationTimeBefore()

Return custom models created before the specified time.

Returns:

Return custom models created before the specified time.

creationTimeAfter

public final Instant creationTimeAfter()

Return custom models created after the specified time.

Returns:

Return custom models created after the specified time.

nameContains

public final String nameContains()

Return custom models only if the job name contains these characters.

Returns:

Return custom models only if the job name contains these characters.

baseModelArnEquals

public final String baseModelArnEquals()

Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

Returns:

Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

foundationModelArnEquals

public final String foundationModelArnEquals()

Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

Returns:

Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

maxResults

public final Integer maxResults()

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

Returns:

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

nextToken

public final String nextToken()

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

sortBy

public final SortModelsBy sortBy()

The field to sort by in the returned list of models.

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

Returns:

The field to sort by in the returned list of models.

See Also:

SortModelsBy

sortByAsString

public final String sortByAsString()

The field to sort by in the returned list of models.

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

Returns:

The field to sort by in the returned list of models.

See Also:

SortModelsBy

sortOrder

public final SortOrder sortOrder()

The sort order of the results.

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 of the results.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The sort order of the results.

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 of the results.

See Also:

SortOrder

isOwned

public final Boolean isOwned()

Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

Returns:

Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

modelStatus

public final ModelStatus modelStatus()

The status of them model to filter results by. Possible values include:

• Creating - Include only models that are currently being created and validated.

• Active - Include only models that have been successfully created and are ready for use.

• Failed - Include only models where the creation process failed.

If you don't specify a status, the API returns models in all states.

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

Returns:

The status of them model to filter results by. Possible values include:

• Creating - Include only models that are currently being created and validated.

• Active - Include only models that have been successfully created and are ready for use.

• Failed - Include only models where the creation process failed.

If you don't specify a status, the API returns models in all states.

See Also:

ModelStatus

modelStatusAsString

public final String modelStatusAsString()

The status of them model to filter results by. Possible values include:

• Creating - Include only models that are currently being created and validated.

• Active - Include only models that have been successfully created and are ready for use.

• Failed - Include only models where the creation process failed.

If you don't specify a status, the API returns models in all states.

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

Returns:

The status of them model to filter results by. Possible values include:

• Creating - Include only models that are currently being created and validated.

• Active - Include only models that have been successfully created and are ready for use.

• Failed - Include only models where the creation process failed.

If you don't specify a status, the API returns models in all states.

See Also:

ModelStatus

toBuilder

public ListCustomModelsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCustomModelsRequest.Builder,ListCustomModelsRequest>

Specified by:

toBuilder in class BedrockRequest

builder

public static ListCustomModelsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo