Interface ListCustomModelsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,BedrockRequest.Builder,Buildable,CopyableBuilder<ListCustomModelsRequest.Builder,ListCustomModelsRequest>,SdkBuilder<ListCustomModelsRequest.Builder,ListCustomModelsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListCustomModelsRequest
@Mutable @NotThreadSafe public static interface ListCustomModelsRequest.Builder extends BedrockRequest.Builder, SdkPojo, CopyableBuilder<ListCustomModelsRequest.Builder,ListCustomModelsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListCustomModelsRequest.BuilderbaseModelArnEquals(String baseModelArnEquals)Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.ListCustomModelsRequest.BuildercreationTimeAfter(Instant creationTimeAfter)Return custom models created after the specified time.ListCustomModelsRequest.BuildercreationTimeBefore(Instant creationTimeBefore)Return custom models created before the specified time.ListCustomModelsRequest.BuilderfoundationModelArnEquals(String foundationModelArnEquals)Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.ListCustomModelsRequest.BuilderisOwned(Boolean isOwned)Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).ListCustomModelsRequest.BuildermaxResults(Integer maxResults)The maximum number of results to return in the response.ListCustomModelsRequest.BuildermodelStatus(String modelStatus)The status of them model to filter results by.ListCustomModelsRequest.BuildermodelStatus(ModelStatus modelStatus)The status of them model to filter results by.ListCustomModelsRequest.BuildernameContains(String nameContains)Return custom models only if the job name contains these characters.ListCustomModelsRequest.BuildernextToken(String nextToken)If the total number of results is greater than themaxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.ListCustomModelsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListCustomModelsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)ListCustomModelsRequest.BuildersortBy(String sortBy)The field to sort by in the returned list of models.ListCustomModelsRequest.BuildersortBy(SortModelsBy sortBy)The field to sort by in the returned list of models.ListCustomModelsRequest.BuildersortOrder(String sortOrder)The sort order of the results.ListCustomModelsRequest.BuildersortOrder(SortOrder sortOrder)The sort order of the results.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
creationTimeBefore
ListCustomModelsRequest.Builder creationTimeBefore(Instant creationTimeBefore)
Return custom models created before the specified time.
- Parameters:
creationTimeBefore- Return custom models created before the specified time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTimeAfter
ListCustomModelsRequest.Builder creationTimeAfter(Instant creationTimeAfter)
Return custom models created after the specified time.
- Parameters:
creationTimeAfter- Return custom models created after the specified time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nameContains
ListCustomModelsRequest.Builder nameContains(String nameContains)
Return custom models only if the job name contains these characters.
- Parameters:
nameContains- Return custom models only if the job name contains these characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
baseModelArnEquals
ListCustomModelsRequest.Builder baseModelArnEquals(String baseModelArnEquals)
Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
- Parameters:
baseModelArnEquals- Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
foundationModelArnEquals
ListCustomModelsRequest.Builder foundationModelArnEquals(String foundationModelArnEquals)
Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
- Parameters:
foundationModelArnEquals- Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListCustomModelsRequest.Builder maxResults(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
nextTokenfield when making another request to return the next batch of results.- Parameters:
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 thenextTokenfield when making another request to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
ListCustomModelsRequest.Builder nextToken(String nextToken)
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.- Parameters:
nextToken- If the total number of results is greater than themaxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
ListCustomModelsRequest.Builder sortBy(String sortBy)
The field to sort by in the returned list of models.
- Parameters:
sortBy- The field to sort by in the returned list of models.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SortModelsBy,SortModelsBy
-
sortBy
ListCustomModelsRequest.Builder sortBy(SortModelsBy sortBy)
The field to sort by in the returned list of models.
- Parameters:
sortBy- The field to sort by in the returned list of models.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SortModelsBy,SortModelsBy
-
sortOrder
ListCustomModelsRequest.Builder sortOrder(String sortOrder)
The sort order of the results.
-
sortOrder
ListCustomModelsRequest.Builder sortOrder(SortOrder sortOrder)
The sort order of the results.
-
isOwned
ListCustomModelsRequest.Builder isOwned(Boolean isOwned)
Return custom models depending on if the current account owns them (
true) or if they were shared with the current account (false).- Parameters:
isOwned- Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modelStatus
ListCustomModelsRequest.Builder modelStatus(String 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ModelStatus,ModelStatus
-
-
modelStatus
ListCustomModelsRequest.Builder modelStatus(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ModelStatus,ModelStatus
-
-
overrideConfiguration
ListCustomModelsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListCustomModelsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-