BatchInferenceJob (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalize.model.BatchInferenceJob

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchInferenceJob
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains information on a batch inference job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchInferenceJob()

Constructors
Constructor and Description
`BatchInferenceJob()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchInferenceJob`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBatchInferenceJobArn()` The Amazon Resource Name (ARN) of the batch inference job.
`BatchInferenceJobConfig`	`getBatchInferenceJobConfig()` A string to string map of the configuration details of a batch inference job.
`Date`	`getCreationDateTime()` The time at which the batch inference job was created.
`String`	`getFailureReason()` If the batch inference job failed, the reason for the failure.
`String`	`getFilterArn()` The ARN of the filter used on the batch inference job.
`BatchInferenceJobInput`	`getJobInput()` The Amazon S3 path that leads to the input data used to generate the batch inference job.
`String`	`getJobName()` The name of the batch inference job.
`BatchInferenceJobOutput`	`getJobOutput()` The Amazon S3 bucket that contains the output data generated by the batch inference job.
`Date`	`getLastUpdatedDateTime()` The time at which the batch inference job was last updated.
`Integer`	`getNumResults()` The number of recommendations generated by the batch inference job.
`String`	`getRoleArn()` The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
`String`	`getSolutionVersionArn()` The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
`String`	`getStatus()` The status of the batch inference job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBatchInferenceJobArn(String batchInferenceJobArn)` The Amazon Resource Name (ARN) of the batch inference job.
`void`	`setBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)` A string to string map of the configuration details of a batch inference job.
`void`	`setCreationDateTime(Date creationDateTime)` The time at which the batch inference job was created.
`void`	`setFailureReason(String failureReason)` If the batch inference job failed, the reason for the failure.
`void`	`setFilterArn(String filterArn)` The ARN of the filter used on the batch inference job.
`void`	`setJobInput(BatchInferenceJobInput jobInput)` The Amazon S3 path that leads to the input data used to generate the batch inference job.
`void`	`setJobName(String jobName)` The name of the batch inference job.
`void`	`setJobOutput(BatchInferenceJobOutput jobOutput)` The Amazon S3 bucket that contains the output data generated by the batch inference job.
`void`	`setLastUpdatedDateTime(Date lastUpdatedDateTime)` The time at which the batch inference job was last updated.
`void`	`setNumResults(Integer numResults)` The number of recommendations generated by the batch inference job.
`void`	`setRoleArn(String roleArn)` The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
`void`	`setSolutionVersionArn(String solutionVersionArn)` The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
`void`	`setStatus(String status)` The status of the batch inference job.
`String`	`toString()` Returns a string representation of this object.
`BatchInferenceJob`	`withBatchInferenceJobArn(String batchInferenceJobArn)` The Amazon Resource Name (ARN) of the batch inference job.
`BatchInferenceJob`	`withBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)` A string to string map of the configuration details of a batch inference job.
`BatchInferenceJob`	`withCreationDateTime(Date creationDateTime)` The time at which the batch inference job was created.
`BatchInferenceJob`	`withFailureReason(String failureReason)` If the batch inference job failed, the reason for the failure.
`BatchInferenceJob`	`withFilterArn(String filterArn)` The ARN of the filter used on the batch inference job.
`BatchInferenceJob`	`withJobInput(BatchInferenceJobInput jobInput)` The Amazon S3 path that leads to the input data used to generate the batch inference job.
`BatchInferenceJob`	`withJobName(String jobName)` The name of the batch inference job.
`BatchInferenceJob`	`withJobOutput(BatchInferenceJobOutput jobOutput)` The Amazon S3 bucket that contains the output data generated by the batch inference job.
`BatchInferenceJob`	`withLastUpdatedDateTime(Date lastUpdatedDateTime)` The time at which the batch inference job was last updated.
`BatchInferenceJob`	`withNumResults(Integer numResults)` The number of recommendations generated by the batch inference job.
`BatchInferenceJob`	`withRoleArn(String roleArn)` The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
`BatchInferenceJob`	`withSolutionVersionArn(String solutionVersionArn)` The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
`BatchInferenceJob`	`withStatus(String status)` The status of the batch inference job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchInferenceJob
```
public BatchInferenceJob()
```
- Method Detail
  - setJobName
```
public void setJobName(String jobName)
```
    The name of the batch inference job.
    
    Parameters:
    
    jobName - The name of the batch inference job.
  - getJobName
```
public String getJobName()
```
    The name of the batch inference job.
    
    Returns:
    
    The name of the batch inference job.
  - withJobName
```
public BatchInferenceJob withJobName(String jobName)
```
    The name of the batch inference job.
    
    Parameters:
    
    jobName - The name of the batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchInferenceJobArn
```
public void setBatchInferenceJobArn(String batchInferenceJobArn)
```
    The Amazon Resource Name (ARN) of the batch inference job.
    
    Parameters:
    
    batchInferenceJobArn - The Amazon Resource Name (ARN) of the batch inference job.
  - getBatchInferenceJobArn
```
public String getBatchInferenceJobArn()
```
    The Amazon Resource Name (ARN) of the batch inference job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the batch inference job.
  - withBatchInferenceJobArn
```
public BatchInferenceJob withBatchInferenceJobArn(String batchInferenceJobArn)
```
    The Amazon Resource Name (ARN) of the batch inference job.
    
    Parameters:
    
    batchInferenceJobArn - The Amazon Resource Name (ARN) of the batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFilterArn
```
public void setFilterArn(String filterArn)
```
    The ARN of the filter used on the batch inference job.
    
    Parameters:
    
    filterArn - The ARN of the filter used on the batch inference job.
  - getFilterArn
```
public String getFilterArn()
```
    The ARN of the filter used on the batch inference job.
    
    Returns:
    
    The ARN of the filter used on the batch inference job.
  - withFilterArn
```
public BatchInferenceJob withFilterArn(String filterArn)
```
    The ARN of the filter used on the batch inference job.
    
    Parameters:
    
    filterArn - The ARN of the filter used on the batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If the batch inference job failed, the reason for the failure.
    
    Parameters:
    
    failureReason - If the batch inference job failed, the reason for the failure.
  - getFailureReason
```
public String getFailureReason()
```
    If the batch inference job failed, the reason for the failure.
    
    Returns:
    
    If the batch inference job failed, the reason for the failure.
  - withFailureReason
```
public BatchInferenceJob withFailureReason(String failureReason)
```
    If the batch inference job failed, the reason for the failure.
    
    Parameters:
    
    failureReason - If the batch inference job failed, the reason for the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSolutionVersionArn
```
public void setSolutionVersionArn(String solutionVersionArn)
```
    The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
    
    Parameters:
    
    solutionVersionArn - The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
  - getSolutionVersionArn
```
public String getSolutionVersionArn()
```
    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.
  - withSolutionVersionArn
```
public BatchInferenceJob withSolutionVersionArn(String solutionVersionArn)
```
    The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
    
    Parameters:
    
    solutionVersionArn - The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumResults
```
public void setNumResults(Integer numResults)
```
    The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
    
    Parameters:
    
    numResults - The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
  - getNumResults
```
public Integer getNumResults()
```
    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.
  - withNumResults
```
public BatchInferenceJob withNumResults(Integer numResults)
```
    The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
    
    Parameters:
    
    numResults - The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobInput
```
public void setJobInput(BatchInferenceJobInput jobInput)
```
    The Amazon S3 path that leads to the input data used to generate the batch inference job.
    
    Parameters:
    
    jobInput - The Amazon S3 path that leads to the input data used to generate the batch inference job.
  - getJobInput
```
public BatchInferenceJobInput getJobInput()
```
    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.
  - withJobInput
```
public BatchInferenceJob withJobInput(BatchInferenceJobInput jobInput)
```
    The Amazon S3 path that leads to the input data used to generate the batch inference job.
    
    Parameters:
    
    jobInput - The Amazon S3 path that leads to the input data used to generate the batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobOutput
```
public void setJobOutput(BatchInferenceJobOutput jobOutput)
```
    The Amazon S3 bucket that contains the output data generated by the batch inference job.
    
    Parameters:
    
    jobOutput - The Amazon S3 bucket that contains the output data generated by the batch inference job.
  - getJobOutput
```
public BatchInferenceJobOutput getJobOutput()
```
    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.
  - withJobOutput
```
public BatchInferenceJob withJobOutput(BatchInferenceJobOutput jobOutput)
```
    The Amazon S3 bucket that contains the output data generated by the batch inference job.
    
    Parameters:
    
    jobOutput - The Amazon S3 bucket that contains the output data generated by the batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchInferenceJobConfig
```
public void setBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)
```
    A string to string map of the configuration details of a batch inference job.
    
    Parameters:
    
    batchInferenceJobConfig - A string to string map of the configuration details of a batch inference job.
  - getBatchInferenceJobConfig
```
public BatchInferenceJobConfig getBatchInferenceJobConfig()
```
    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.
  - withBatchInferenceJobConfig
```
public BatchInferenceJob withBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)
```
    A string to string map of the configuration details of a batch inference job.
    
    Parameters:
    
    batchInferenceJobConfig - A string to string map of the configuration details of a batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
    
    Parameters:
    
    roleArn - The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public BatchInferenceJob withRoleArn(String roleArn)
```
    The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
    
    Parameters:
    
    roleArn - The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the batch inference job. The status is one of the following values:
    - PENDING
    - IN PROGRESS
    - ACTIVE
    - CREATE FAILED
    Parameters:
    status - The status of the batch inference job. The status is one of the following values:
    
    PENDING
    
    IN PROGRESS
    
    ACTIVE
    
    CREATE FAILED
  - getStatus
```
public String getStatus()
```
    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
  - withStatus
```
public BatchInferenceJob withStatus(String status)
```
    The status of the batch inference job. The status is one of the following values:
    - PENDING
    - IN PROGRESS
    - ACTIVE
    - CREATE FAILED
    Parameters:
    status - The status of the batch inference job. The status is one of the following values:
    
    PENDING
    
    IN PROGRESS
    
    ACTIVE
    
    CREATE FAILED
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDateTime
```
public void setCreationDateTime(Date creationDateTime)
```
    The time at which the batch inference job was created.
    
    Parameters:
    
    creationDateTime - The time at which the batch inference job was created.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    The time at which the batch inference job was created.
    
    Returns:
    
    The time at which the batch inference job was created.
  - withCreationDateTime
```
public BatchInferenceJob withCreationDateTime(Date creationDateTime)
```
    The time at which the batch inference job was created.
    
    Parameters:
    
    creationDateTime - The time at which the batch inference job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDateTime
```
public void setLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The time at which the batch inference job was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The time at which the batch inference job was last updated.
  - getLastUpdatedDateTime
```
public Date getLastUpdatedDateTime()
```
    The time at which the batch inference job was last updated.
    
    Returns:
    
    The time at which the batch inference job was last updated.
  - withLastUpdatedDateTime
```
public BatchInferenceJob withLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The time at which the batch inference job was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The time at which the batch inference job was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BatchInferenceJob clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.561

Class BatchInferenceJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchInferenceJob

Method Detail

setJobName

getJobName

withJobName

setBatchInferenceJobArn

getBatchInferenceJobArn

withBatchInferenceJobArn

setFilterArn

getFilterArn

withFilterArn

setFailureReason

getFailureReason

withFailureReason

setSolutionVersionArn

getSolutionVersionArn

withSolutionVersionArn

setNumResults

getNumResults

withNumResults

setJobInput

getJobInput

withJobInput

setJobOutput

getJobOutput

withJobOutput

setBatchInferenceJobConfig

getBatchInferenceJobConfig

withBatchInferenceJobConfig

setRoleArn

getRoleArn

withRoleArn

setStatus

getStatus

withStatus

setCreationDateTime

getCreationDateTime

withCreationDateTime

setLastUpdatedDateTime

getLastUpdatedDateTime

withLastUpdatedDateTime

toString

equals

hashCode

clone

marshall