Class ListModelInvocationJobsRequest
- 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.ListModelInvocationJobsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListModelInvocationJobsRequest extends BedrockRequest implements ToCopyableBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListModelInvocationJobsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListModelInvocationJobsRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()IntegermaxResults()The maximum number of results to return.StringnameContains()Specify a string to filter for batch inference jobs whose names contain the string.StringnextToken()If there were more results than the value you specified in themaxResultsfield in a previousListModelInvocationJobsrequest, the response would have returned anextTokenvalue.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ListModelInvocationJobsRequest.Builder>serializableBuilderClass()SortJobsBysortBy()An attribute by which to sort the results.StringsortByAsString()An attribute by which to sort the results.SortOrdersortOrder()Specifies whether to sort the results by ascending or descending order.StringsortOrderAsString()Specifies whether to sort the results by ascending or descending order.ModelInvocationJobStatusstatusEquals()Specify a status to filter for batch inference jobs whose statuses match the string you specify.StringstatusEqualsAsString()Specify a status to filter for batch inference jobs whose statuses match the string you specify.InstantsubmitTimeAfter()Specify a time to filter for batch inference jobs that were submitted after the time you specify.InstantsubmitTimeBefore()Specify a time to filter for batch inference jobs that were submitted before the time you specify.ListModelInvocationJobsRequest.BuildertoBuilder()StringtoString()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
-
submitTimeAfter
public final Instant submitTimeAfter()
Specify a time to filter for batch inference jobs that were submitted after the time you specify.
- Returns:
- Specify a time to filter for batch inference jobs that were submitted after the time you specify.
-
submitTimeBefore
public final Instant submitTimeBefore()
Specify a time to filter for batch inference jobs that were submitted before the time you specify.
- Returns:
- Specify a time to filter for batch inference jobs that were submitted before the time you specify.
-
statusEquals
public final ModelInvocationJobStatus statusEquals()
Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.
-
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
If the service returns an enum value that is not available in the current SDK version,
statusEqualswill returnModelInvocationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusEqualsAsString().- Returns:
- Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.
-
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
-
- See Also:
ModelInvocationJobStatus
-
-
statusEqualsAsString
public final String statusEqualsAsString()
Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.
-
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
If the service returns an enum value that is not available in the current SDK version,
statusEqualswill returnModelInvocationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusEqualsAsString().- Returns:
- Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.
-
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
-
- See Also:
ModelInvocationJobStatus
-
-
nameContains
public final String nameContains()
Specify a string to filter for batch inference jobs whose names contain the string.
- Returns:
- Specify a string to filter for batch inference jobs whose names contain the string.
-
maxResults
public final Integer maxResults()
The maximum number of results to return. If there are more results than the number that you specify, a
nextTokenvalue is returned. Use thenextTokenin a request to return the next batch of results.- Returns:
- The maximum number of results to return. If there are more results than the number that you specify, a
nextTokenvalue is returned. Use thenextTokenin a request to return the next batch of results.
-
nextToken
public final String nextToken()
If there were more results than the value you specified in the
maxResultsfield in a previousListModelInvocationJobsrequest, the response would have returned anextTokenvalue. To see the next batch of results, send thenextTokenvalue in another request.- Returns:
- If there were more results than the value you specified in the
maxResultsfield in a previousListModelInvocationJobsrequest, the response would have returned anextTokenvalue. To see the next batch of results, send thenextTokenvalue in another request.
-
sortBy
public final SortJobsBy sortBy()
An attribute by which to sort the results.
If the service returns an enum value that is not available in the current SDK version,
sortBywill returnSortJobsBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- An attribute by which to sort the results.
- See Also:
SortJobsBy
-
sortByAsString
public final String sortByAsString()
An attribute by which to sort the results.
If the service returns an enum value that is not available in the current SDK version,
sortBywill returnSortJobsBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- An attribute by which to sort the results.
- See Also:
SortJobsBy
-
sortOrder
public final SortOrder sortOrder()
Specifies whether to sort the results by ascending or descending order.
If the service returns an enum value that is not available in the current SDK version,
sortOrderwill returnSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortOrderAsString().- Returns:
- Specifies whether to sort the results by ascending or descending order.
- See Also:
SortOrder
-
sortOrderAsString
public final String sortOrderAsString()
Specifies whether to sort the results by ascending or descending order.
If the service returns an enum value that is not available in the current SDK version,
sortOrderwill returnSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortOrderAsString().- Returns:
- Specifies whether to sort the results by ascending or descending order.
- See Also:
SortOrder
-
toBuilder
public ListModelInvocationJobsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>- Specified by:
toBuilderin classBedrockRequest
-
builder
public static ListModelInvocationJobsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListModelInvocationJobsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-