java.lang.Object
- software.amazon.awssdk.services.personalize.model.BatchInferenceJob

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BatchInferenceJob.Builder,BatchInferenceJob>

@Generated("software.amazon.awssdk:codegen")
public final class BatchInferenceJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchInferenceJob.Builder,BatchInferenceJob>

Contains information on a batch inference job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface BatchInferenceJob.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`batchInferenceJobArn()`	The Amazon Resource Name (ARN) of the batch inference job.
`BatchInferenceJobConfig`	`batchInferenceJobConfig()`	A string to string map of the configuration details of a batch inference job.
`BatchInferenceJobMode`	`batchInferenceJobMode()`	The job's mode.
`String`	`batchInferenceJobModeAsString()`	The job's mode.
`static BatchInferenceJob.Builder`	`builder()`
`Instant`	`creationDateTime()`	The time at which the batch inference job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()`	If the batch inference job failed, the reason for the failure.
`String`	`filterArn()`	The ARN of the filter used on the batch inference job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`BatchInferenceJobInput`	`jobInput()`	The Amazon S3 path that leads to the input data used to generate the batch inference job.
`String`	`jobName()`	The name of the batch inference job.
`BatchInferenceJobOutput`	`jobOutput()`	The Amazon S3 bucket that contains the output data generated by the batch inference job.
`Instant`	`lastUpdatedDateTime()`	The time at which the batch inference job was last updated.
`Integer`	`numResults()`	The number of recommendations generated by the batch inference job.
`String`	`roleArn()`	The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BatchInferenceJob.Builder>`	`serializableBuilderClass()`
`String`	`solutionVersionArn()`	The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
`String`	`status()`	The status of the batch inference job.
`ThemeGenerationConfig`	`themeGenerationConfig()`	The job's theme generation settings.
`BatchInferenceJob.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - jobName
```
public final String jobName()
```
    The name of the batch inference job.
    
    Returns:
    
    The name of the batch inference job.
  - batchInferenceJobArn
```
public final String batchInferenceJobArn()
```
    The Amazon Resource Name (ARN) of the batch inference job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the batch inference job.
  - filterArn
```
public final String 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
```
public final String 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
```
public final String 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
```
public final Integer 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
```
public final BatchInferenceJobInput 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
```
public final BatchInferenceJobOutput 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
```
public final BatchInferenceJobConfig 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
```
public final String 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
```
public final BatchInferenceJobMode batchInferenceJobMode()
```
    The job's mode.
    
    If the service returns an enum value that is not available in the current SDK version, batchInferenceJobMode will return BatchInferenceJobMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from batchInferenceJobModeAsString().
    
    Returns:
    
    The job's mode.
    
    See Also:
    
    BatchInferenceJobMode
  - batchInferenceJobModeAsString
```
public final String batchInferenceJobModeAsString()
```
    The job's mode.
    
    If the service returns an enum value that is not available in the current SDK version, batchInferenceJobMode will return BatchInferenceJobMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from batchInferenceJobModeAsString().
    
    Returns:
    
    The job's mode.
    
    See Also:
    
    BatchInferenceJobMode
  - themeGenerationConfig
```
public final ThemeGenerationConfig themeGenerationConfig()
```
    The job's theme generation settings.
    
    Returns:
    
    The job's theme generation settings.
  - status
```
public final String 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
```
public final Instant creationDateTime()
```
    The time at which the batch inference job was created.
    
    Returns:
    
    The time at which the batch inference job was created.
  - lastUpdatedDateTime
```
public final Instant 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
```
public BatchInferenceJob.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BatchInferenceJob.Builder,BatchInferenceJob>
  - builder
```
public static BatchInferenceJob.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BatchInferenceJob.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class BatchInferenceJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobName

batchInferenceJobArn

filterArn

failureReason

solutionVersionArn

numResults

jobInput

jobOutput

batchInferenceJobConfig

roleArn

batchInferenceJobMode

batchInferenceJobModeAsString

themeGenerationConfig

status

creationDateTime

lastUpdatedDateTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields