Class BatchInferenceJob
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BatchInferenceJob.Builder,
BatchInferenceJob>
Contains information on a batch inference job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Resource Name (ARN) of the batch inference job.final BatchInferenceJobConfig
A string to string map of the configuration details of a batch inference job.final BatchInferenceJobMode
The job's mode.final String
The job's mode.static BatchInferenceJob.Builder
builder()
final Instant
The time at which the batch inference job was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If the batch inference job failed, the reason for the failure.final String
The ARN of the filter used on the batch inference job.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final BatchInferenceJobInput
jobInput()
The Amazon S3 path that leads to the input data used to generate the batch inference job.final String
jobName()
The name of the batch inference job.final BatchInferenceJobOutput
The Amazon S3 bucket that contains the output data generated by the batch inference job.final Instant
The time at which the batch inference job was last updated.final Integer
The number of recommendations generated by the batch inference job.final String
roleArn()
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.static Class
<? extends BatchInferenceJob.Builder> final String
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.final String
status()
The status of the batch inference job.final ThemeGenerationConfig
The job's theme generation settings.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobName
The name of the batch inference job.
- Returns:
- The name of the batch inference job.
-
batchInferenceJobArn
The Amazon Resource Name (ARN) of the batch inference job.
- Returns:
- The Amazon Resource Name (ARN) of the batch inference job.
-
filterArn
The ARN of the filter used on the batch inference job.
- Returns:
- The ARN of the filter used on the batch inference job.
-
failureReason
If the batch inference job failed, the reason for the failure.
- Returns:
- If the batch inference job failed, the reason for the failure.
-
solutionVersionArn
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
- Returns:
- The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
-
numResults
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
- Returns:
- The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
-
jobInput
The Amazon S3 path that leads to the input data used to generate the batch inference job.
- Returns:
- The Amazon S3 path that leads to the input data used to generate the batch inference job.
-
jobOutput
The Amazon S3 bucket that contains the output data generated by the batch inference job.
- Returns:
- The Amazon S3 bucket that contains the output data generated by the batch inference job.
-
batchInferenceJobConfig
A string to string map of the configuration details of a batch inference job.
- Returns:
- A string to string map of the configuration details of a batch inference job.
-
roleArn
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
- Returns:
- The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
-
batchInferenceJobMode
The job's mode.
If the service returns an enum value that is not available in the current SDK version,
batchInferenceJobMode
will returnBatchInferenceJobMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombatchInferenceJobModeAsString()
.- Returns:
- The job's mode.
- See Also:
-
batchInferenceJobModeAsString
The job's mode.
If the service returns an enum value that is not available in the current SDK version,
batchInferenceJobMode
will returnBatchInferenceJobMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombatchInferenceJobModeAsString()
.- Returns:
- The job's mode.
- See Also:
-
themeGenerationConfig
The job's theme generation settings.
- Returns:
- The job's theme generation settings.
-
status
The status of the batch inference job. The status is one of the following values:
-
PENDING
-
IN PROGRESS
-
ACTIVE
-
CREATE FAILED
- Returns:
- The status of the batch inference job. The status is one of the following values:
-
PENDING
-
IN PROGRESS
-
ACTIVE
-
CREATE FAILED
-
-
-
creationDateTime
The time at which the batch inference job was created.
- Returns:
- The time at which the batch inference job was created.
-
lastUpdatedDateTime
The time at which the batch inference job was last updated.
- Returns:
- The time at which the batch inference job was last updated.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BatchInferenceJob.Builder,
BatchInferenceJob> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-