@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.
Constructor and Description |
---|
BatchInferenceJob() |
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.
|
String |
getBatchInferenceJobMode()
The job's mode.
|
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.
|
ThemeGenerationConfig |
getThemeGenerationConfig()
The job's theme generation settings.
|
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 |
setBatchInferenceJobMode(String batchInferenceJobMode)
The job's mode.
|
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.
|
void |
setThemeGenerationConfig(ThemeGenerationConfig themeGenerationConfig)
The job's theme generation settings.
|
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 |
withBatchInferenceJobMode(BatchInferenceJobMode batchInferenceJobMode)
The job's mode.
|
BatchInferenceJob |
withBatchInferenceJobMode(String batchInferenceJobMode)
The job's mode.
|
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.
|
BatchInferenceJob |
withThemeGenerationConfig(ThemeGenerationConfig themeGenerationConfig)
The job's theme generation settings.
|
public void setJobName(String jobName)
The name of the batch inference job.
jobName
- The name of the batch inference job.public String getJobName()
The name of the batch inference job.
public BatchInferenceJob withJobName(String jobName)
The name of the batch inference job.
jobName
- The name of the batch inference job.public void setBatchInferenceJobArn(String batchInferenceJobArn)
The Amazon Resource Name (ARN) of the batch inference job.
batchInferenceJobArn
- The Amazon Resource Name (ARN) of the batch inference job.public String getBatchInferenceJobArn()
The Amazon Resource Name (ARN) of the batch inference job.
public BatchInferenceJob withBatchInferenceJobArn(String batchInferenceJobArn)
The Amazon Resource Name (ARN) of the batch inference job.
batchInferenceJobArn
- The Amazon Resource Name (ARN) of the batch inference job.public void setFilterArn(String filterArn)
The ARN of the filter used on the batch inference job.
filterArn
- The ARN of the filter used on the batch inference job.public String getFilterArn()
The ARN of the filter used on the batch inference job.
public BatchInferenceJob withFilterArn(String filterArn)
The ARN of the filter used on the batch inference job.
filterArn
- The ARN of the filter used on the batch inference job.public void setFailureReason(String failureReason)
If the batch inference job failed, the reason for the failure.
failureReason
- If the batch inference job failed, the reason for the failure.public String getFailureReason()
If the batch inference job failed, the reason for the failure.
public BatchInferenceJob withFailureReason(String failureReason)
If the batch inference job failed, the reason for the failure.
failureReason
- If the batch inference job failed, the reason for the failure.public void setSolutionVersionArn(String solutionVersionArn)
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
solutionVersionArn
- The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.public String getSolutionVersionArn()
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
public BatchInferenceJob withSolutionVersionArn(String solutionVersionArn)
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
solutionVersionArn
- The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.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.
numResults
- The number of recommendations generated by the batch inference job. This number includes the error
messages generated for failed input records.public Integer getNumResults()
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
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.
numResults
- The number of recommendations generated by the batch inference job. This number includes the error
messages generated for failed input records.public void setJobInput(BatchInferenceJobInput jobInput)
The Amazon S3 path that leads to the input data used to generate the batch inference job.
jobInput
- The Amazon S3 path that leads to the input data used to generate the batch inference job.public BatchInferenceJobInput getJobInput()
The Amazon S3 path that leads to the input data used to generate the batch inference job.
public BatchInferenceJob withJobInput(BatchInferenceJobInput jobInput)
The Amazon S3 path that leads to the input data used to generate the batch inference job.
jobInput
- The Amazon S3 path that leads to the input data used to generate the batch inference job.public void setJobOutput(BatchInferenceJobOutput jobOutput)
The Amazon S3 bucket that contains the output data generated by the batch inference job.
jobOutput
- The Amazon S3 bucket that contains the output data generated by the batch inference job.public BatchInferenceJobOutput getJobOutput()
The Amazon S3 bucket that contains the output data generated by the batch inference job.
public BatchInferenceJob withJobOutput(BatchInferenceJobOutput jobOutput)
The Amazon S3 bucket that contains the output data generated by the batch inference job.
jobOutput
- The Amazon S3 bucket that contains the output data generated by the batch inference job.public void setBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)
A string to string map of the configuration details of a batch inference job.
batchInferenceJobConfig
- A string to string map of the configuration details of a batch inference job.public BatchInferenceJobConfig getBatchInferenceJobConfig()
A string to string map of the configuration details of a batch inference job.
public BatchInferenceJob withBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)
A string to string map of the configuration details of a batch inference job.
batchInferenceJobConfig
- A string to string map of the configuration details of a batch inference job.public void setRoleArn(String roleArn)
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
roleArn
- The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.public String getRoleArn()
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
public BatchInferenceJob withRoleArn(String roleArn)
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
roleArn
- The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.public void setBatchInferenceJobMode(String batchInferenceJobMode)
The job's mode.
batchInferenceJobMode
- The job's mode.BatchInferenceJobMode
public String getBatchInferenceJobMode()
The job's mode.
BatchInferenceJobMode
public BatchInferenceJob withBatchInferenceJobMode(String batchInferenceJobMode)
The job's mode.
batchInferenceJobMode
- The job's mode.BatchInferenceJobMode
public BatchInferenceJob withBatchInferenceJobMode(BatchInferenceJobMode batchInferenceJobMode)
The job's mode.
batchInferenceJobMode
- The job's mode.BatchInferenceJobMode
public void setThemeGenerationConfig(ThemeGenerationConfig themeGenerationConfig)
The job's theme generation settings.
themeGenerationConfig
- The job's theme generation settings.public ThemeGenerationConfig getThemeGenerationConfig()
The job's theme generation settings.
public BatchInferenceJob withThemeGenerationConfig(ThemeGenerationConfig themeGenerationConfig)
The job's theme generation settings.
themeGenerationConfig
- The job's theme generation settings.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
status
- The status of the batch inference job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
public String getStatus()
The status of the batch inference job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
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
status
- The status of the batch inference job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
public void setCreationDateTime(Date creationDateTime)
The time at which the batch inference job was created.
creationDateTime
- The time at which the batch inference job was created.public Date getCreationDateTime()
The time at which the batch inference job was created.
public BatchInferenceJob withCreationDateTime(Date creationDateTime)
The time at which the batch inference job was created.
creationDateTime
- The time at which the batch inference job was created.public void setLastUpdatedDateTime(Date lastUpdatedDateTime)
The time at which the batch inference job was last updated.
lastUpdatedDateTime
- The time at which the batch inference job was last updated.public Date getLastUpdatedDateTime()
The time at which the batch inference job was last updated.
public BatchInferenceJob withLastUpdatedDateTime(Date lastUpdatedDateTime)
The time at which the batch inference job was last updated.
lastUpdatedDateTime
- The time at which the batch inference job was last updated.public String toString()
toString
in class Object
Object.toString()
public BatchInferenceJob clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.