All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.personalize.model.BatchInferenceJob Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon Personalize module holds the client classes that are used for communicating with Amazon Personalize Service

There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.personalize.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 

* Contains information on a batch inference job. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class BatchInferenceJob implements Serializable, Cloneable, StructuredPojo { /** *

* The name of the batch inference job. *

*/ private String jobName; /** *

* The Amazon Resource Name (ARN) of the batch inference job. *

*/ private String batchInferenceJobArn; /** *

* The ARN of the filter used on the batch inference job. *

*/ private String filterArn; /** *

* If the batch inference job failed, the reason for the failure. *

*/ private String failureReason; /** *

* The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created. *

*/ private String solutionVersionArn; /** *

* The number of recommendations generated by the batch inference job. This number includes the error messages * generated for failed input records. *

*/ private Integer numResults; /** *

* The Amazon S3 path that leads to the input data used to generate the batch inference job. *

*/ private BatchInferenceJobInput jobInput; /** *

* The Amazon S3 bucket that contains the output data generated by the batch inference job. *

*/ private BatchInferenceJobOutput jobOutput; /** *

* A string to string map of the configuration details of a batch inference job. *

*/ private BatchInferenceJobConfig batchInferenceJobConfig; /** *

* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job. *

*/ private String roleArn; /** *

* The job's mode. *

*/ private String batchInferenceJobMode; /** *

* The job's theme generation settings. *

*/ private ThemeGenerationConfig themeGenerationConfig; /** *

* The status of the batch inference job. The status is one of the following values: *

*
    *
  • *

    * PENDING *

    *
  • *
  • *

    * IN PROGRESS *

    *
  • *
  • *

    * ACTIVE *

    *
  • *
  • *

    * CREATE FAILED *

    *
  • *
*/ private String status; /** *

* The time at which the batch inference job was created. *

*/ private java.util.Date creationDateTime; /** *

* The time at which the batch inference job was last updated. *

*/ private java.util.Date lastUpdatedDateTime; /** *

* The name of the batch inference job. *

* * @param jobName * The name of the batch inference job. */ public void setJobName(String jobName) { this.jobName = jobName; } /** *

* The name of the batch inference job. *

* * @return The name of the batch inference job. */ public String getJobName() { return this.jobName; } /** *

* The name of the batch inference job. *

* * @param jobName * The name of the batch inference job. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withJobName(String jobName) { setJobName(jobName); return this; } /** *

* The Amazon Resource Name (ARN) of the batch inference job. *

* * @param batchInferenceJobArn * The Amazon Resource Name (ARN) of the batch inference job. */ public void setBatchInferenceJobArn(String batchInferenceJobArn) { this.batchInferenceJobArn = batchInferenceJobArn; } /** *

* The Amazon Resource Name (ARN) of the batch inference job. *

* * @return The Amazon Resource Name (ARN) of the batch inference job. */ public String getBatchInferenceJobArn() { return this.batchInferenceJobArn; } /** *

* The Amazon Resource Name (ARN) of the batch inference job. *

* * @param batchInferenceJobArn * The Amazon Resource Name (ARN) of the batch inference job. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withBatchInferenceJobArn(String batchInferenceJobArn) { setBatchInferenceJobArn(batchInferenceJobArn); return this; } /** *

* The ARN of the filter used on the batch inference job. *

* * @param filterArn * The ARN of the filter used on the batch inference job. */ public void setFilterArn(String filterArn) { this.filterArn = filterArn; } /** *

* The ARN of the filter used on the batch inference job. *

* * @return The ARN of the filter used on the batch inference job. */ public String getFilterArn() { return this.filterArn; } /** *

* The ARN of the filter used on the batch inference job. *

* * @param filterArn * The ARN of the filter used on the batch inference job. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withFilterArn(String filterArn) { setFilterArn(filterArn); return this; } /** *

* If the batch inference job failed, the reason for the failure. *

* * @param failureReason * If the batch inference job failed, the reason for the failure. */ public void setFailureReason(String failureReason) { this.failureReason = failureReason; } /** *

* If the batch inference job failed, the reason for the failure. *

* * @return If the batch inference job failed, the reason for the failure. */ public String getFailureReason() { return this.failureReason; } /** *

* If the batch inference job failed, the reason for the failure. *

* * @param failureReason * If the batch inference job failed, the reason for the failure. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withFailureReason(String failureReason) { setFailureReason(failureReason); return this; } /** *

* The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created. *

* * @param solutionVersionArn * The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created. */ public void setSolutionVersionArn(String solutionVersionArn) { this.solutionVersionArn = solutionVersionArn; } /** *

* The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created. *

* * @return The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created. */ public String getSolutionVersionArn() { return this.solutionVersionArn; } /** *

* The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created. *

* * @param solutionVersionArn * The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withSolutionVersionArn(String solutionVersionArn) { setSolutionVersionArn(solutionVersionArn); return this; } /** *

* The number of recommendations generated by the batch inference job. This number includes the error messages * generated for failed input records. *

* * @param numResults * The number of recommendations generated by the batch inference job. This number includes the error * messages generated for failed input records. */ public void setNumResults(Integer numResults) { this.numResults = numResults; } /** *

* The number of recommendations generated by the batch inference job. This number includes the error messages * generated for failed input records. *

* * @return The number of recommendations generated by the batch inference job. This number includes the error * messages generated for failed input records. */ public Integer getNumResults() { return this.numResults; } /** *

* The number of recommendations generated by the batch inference job. This number includes the error messages * generated for failed input records. *

* * @param numResults * The number of recommendations generated by the batch inference job. This number includes the error * messages generated for failed input records. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withNumResults(Integer numResults) { setNumResults(numResults); return this; } /** *

* The Amazon S3 path that leads to the input data used to generate the batch inference job. *

* * @param jobInput * The Amazon S3 path that leads to the input data used to generate the batch inference job. */ public void setJobInput(BatchInferenceJobInput jobInput) { this.jobInput = jobInput; } /** *

* The Amazon S3 path that leads to the input data used to generate the batch inference job. *

* * @return The Amazon S3 path that leads to the input data used to generate the batch inference job. */ public BatchInferenceJobInput getJobInput() { return this.jobInput; } /** *

* The Amazon S3 path that leads to the input data used to generate the batch inference job. *

* * @param jobInput * The Amazon S3 path that leads to the input data used to generate the batch inference job. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withJobInput(BatchInferenceJobInput jobInput) { setJobInput(jobInput); return this; } /** *

* The Amazon S3 bucket that contains the output data generated by the batch inference job. *

* * @param jobOutput * The Amazon S3 bucket that contains the output data generated by the batch inference job. */ public void setJobOutput(BatchInferenceJobOutput jobOutput) { this.jobOutput = jobOutput; } /** *

* The Amazon S3 bucket that contains the output data generated by the batch inference job. *

* * @return The Amazon S3 bucket that contains the output data generated by the batch inference job. */ public BatchInferenceJobOutput getJobOutput() { return this.jobOutput; } /** *

* The Amazon S3 bucket that contains the output data generated by the batch inference job. *

* * @param jobOutput * The Amazon S3 bucket that contains the output data generated by the batch inference job. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withJobOutput(BatchInferenceJobOutput jobOutput) { setJobOutput(jobOutput); return this; } /** *

* A string to string map of the configuration details of a batch inference job. *

* * @param batchInferenceJobConfig * A string to string map of the configuration details of a batch inference job. */ public void setBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig) { this.batchInferenceJobConfig = batchInferenceJobConfig; } /** *

* A string to string map of the configuration details of a batch inference job. *

* * @return A string to string map of the configuration details of a batch inference job. */ public BatchInferenceJobConfig getBatchInferenceJobConfig() { return this.batchInferenceJobConfig; } /** *

* A string to string map of the configuration details of a batch inference job. *

* * @param batchInferenceJobConfig * A string to string map of the configuration details of a batch inference job. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig) { setBatchInferenceJobConfig(batchInferenceJobConfig); return this; } /** *

* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job. *

* * @param roleArn * The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job. */ public void setRoleArn(String roleArn) { this.roleArn = roleArn; } /** *

* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job. *

* * @return The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job. */ public String getRoleArn() { return this.roleArn; } /** *

* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job. *

* * @param roleArn * The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withRoleArn(String roleArn) { setRoleArn(roleArn); return this; } /** *

* The job's mode. *

* * @param batchInferenceJobMode * The job's mode. * @see BatchInferenceJobMode */ public void setBatchInferenceJobMode(String batchInferenceJobMode) { this.batchInferenceJobMode = batchInferenceJobMode; } /** *

* The job's mode. *

* * @return The job's mode. * @see BatchInferenceJobMode */ public String getBatchInferenceJobMode() { return this.batchInferenceJobMode; } /** *

* The job's mode. *

* * @param batchInferenceJobMode * The job's mode. * @return Returns a reference to this object so that method calls can be chained together. * @see BatchInferenceJobMode */ public BatchInferenceJob withBatchInferenceJobMode(String batchInferenceJobMode) { setBatchInferenceJobMode(batchInferenceJobMode); return this; } /** *

* The job's mode. *

* * @param batchInferenceJobMode * The job's mode. * @return Returns a reference to this object so that method calls can be chained together. * @see BatchInferenceJobMode */ public BatchInferenceJob withBatchInferenceJobMode(BatchInferenceJobMode batchInferenceJobMode) { this.batchInferenceJobMode = batchInferenceJobMode.toString(); return this; } /** *

* The job's theme generation settings. *

* * @param themeGenerationConfig * The job's theme generation settings. */ public void setThemeGenerationConfig(ThemeGenerationConfig themeGenerationConfig) { this.themeGenerationConfig = themeGenerationConfig; } /** *

* The job's theme generation settings. *

* * @return The job's theme generation settings. */ public ThemeGenerationConfig getThemeGenerationConfig() { return this.themeGenerationConfig; } /** *

* The job's theme generation settings. *

* * @param themeGenerationConfig * The job's theme generation settings. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withThemeGenerationConfig(ThemeGenerationConfig themeGenerationConfig) { setThemeGenerationConfig(themeGenerationConfig); return this; } /** *

* The status of the batch inference job. The status is one of the following values: *

*
    *
  • *

    * PENDING *

    *
  • *
  • *

    * IN PROGRESS *

    *
  • *
  • *

    * ACTIVE *

    *
  • *
  • *

    * CREATE FAILED *

    *
  • *
* * @param status * The status of the batch inference job. The status is one of the following values:

*
    *
  • *

    * PENDING *

    *
  • *
  • *

    * IN PROGRESS *

    *
  • *
  • *

    * ACTIVE *

    *
  • *
  • *

    * CREATE FAILED *

    *
  • */ public void setStatus(String status) { this.status = status; } /** *

    * The status of the batch inference job. The status is one of the following values: *

    *
      *
    • *

      * PENDING *

      *
    • *
    • *

      * IN PROGRESS *

      *
    • *
    • *

      * ACTIVE *

      *
    • *
    • *

      * CREATE FAILED *

      *
    • *
    * * @return The status of the batch inference job. The status is one of the following values:

    *
      *
    • *

      * PENDING *

      *
    • *
    • *

      * IN PROGRESS *

      *
    • *
    • *

      * ACTIVE *

      *
    • *
    • *

      * CREATE FAILED *

      *
    • */ public String getStatus() { return this.status; } /** *

      * The status of the batch inference job. The status is one of the following values: *

      *
        *
      • *

        * PENDING *

        *
      • *
      • *

        * IN PROGRESS *

        *
      • *
      • *

        * ACTIVE *

        *
      • *
      • *

        * CREATE FAILED *

        *
      • *
      * * @param status * The status of the batch inference job. The status is one of the following values:

      *
        *
      • *

        * PENDING *

        *
      • *
      • *

        * IN PROGRESS *

        *
      • *
      • *

        * ACTIVE *

        *
      • *
      • *

        * CREATE FAILED *

        *
      • * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withStatus(String status) { setStatus(status); return this; } /** *

        * The time at which the batch inference job was created. *

        * * @param creationDateTime * The time at which the batch inference job was created. */ public void setCreationDateTime(java.util.Date creationDateTime) { this.creationDateTime = creationDateTime; } /** *

        * The time at which the batch inference job was created. *

        * * @return The time at which the batch inference job was created. */ public java.util.Date getCreationDateTime() { return this.creationDateTime; } /** *

        * The time at which the batch inference job was created. *

        * * @param creationDateTime * The time at which the batch inference job was created. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withCreationDateTime(java.util.Date creationDateTime) { setCreationDateTime(creationDateTime); return this; } /** *

        * The time at which the batch inference job was last updated. *

        * * @param lastUpdatedDateTime * The time at which the batch inference job was last updated. */ public void setLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) { this.lastUpdatedDateTime = lastUpdatedDateTime; } /** *

        * The time at which the batch inference job was last updated. *

        * * @return The time at which the batch inference job was last updated. */ public java.util.Date getLastUpdatedDateTime() { return this.lastUpdatedDateTime; } /** *

        * The time at which the batch inference job was last updated. *

        * * @param lastUpdatedDateTime * The time at which the batch inference job was last updated. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchInferenceJob withLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) { setLastUpdatedDateTime(lastUpdatedDateTime); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getJobName() != null) sb.append("JobName: ").append(getJobName()).append(","); if (getBatchInferenceJobArn() != null) sb.append("BatchInferenceJobArn: ").append(getBatchInferenceJobArn()).append(","); if (getFilterArn() != null) sb.append("FilterArn: ").append(getFilterArn()).append(","); if (getFailureReason() != null) sb.append("FailureReason: ").append(getFailureReason()).append(","); if (getSolutionVersionArn() != null) sb.append("SolutionVersionArn: ").append(getSolutionVersionArn()).append(","); if (getNumResults() != null) sb.append("NumResults: ").append(getNumResults()).append(","); if (getJobInput() != null) sb.append("JobInput: ").append(getJobInput()).append(","); if (getJobOutput() != null) sb.append("JobOutput: ").append(getJobOutput()).append(","); if (getBatchInferenceJobConfig() != null) sb.append("BatchInferenceJobConfig: ").append(getBatchInferenceJobConfig()).append(","); if (getRoleArn() != null) sb.append("RoleArn: ").append(getRoleArn()).append(","); if (getBatchInferenceJobMode() != null) sb.append("BatchInferenceJobMode: ").append(getBatchInferenceJobMode()).append(","); if (getThemeGenerationConfig() != null) sb.append("ThemeGenerationConfig: ").append(getThemeGenerationConfig()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getCreationDateTime() != null) sb.append("CreationDateTime: ").append(getCreationDateTime()).append(","); if (getLastUpdatedDateTime() != null) sb.append("LastUpdatedDateTime: ").append(getLastUpdatedDateTime()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof BatchInferenceJob == false) return false; BatchInferenceJob other = (BatchInferenceJob) obj; if (other.getJobName() == null ^ this.getJobName() == null) return false; if (other.getJobName() != null && other.getJobName().equals(this.getJobName()) == false) return false; if (other.getBatchInferenceJobArn() == null ^ this.getBatchInferenceJobArn() == null) return false; if (other.getBatchInferenceJobArn() != null && other.getBatchInferenceJobArn().equals(this.getBatchInferenceJobArn()) == false) return false; if (other.getFilterArn() == null ^ this.getFilterArn() == null) return false; if (other.getFilterArn() != null && other.getFilterArn().equals(this.getFilterArn()) == false) return false; if (other.getFailureReason() == null ^ this.getFailureReason() == null) return false; if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false) return false; if (other.getSolutionVersionArn() == null ^ this.getSolutionVersionArn() == null) return false; if (other.getSolutionVersionArn() != null && other.getSolutionVersionArn().equals(this.getSolutionVersionArn()) == false) return false; if (other.getNumResults() == null ^ this.getNumResults() == null) return false; if (other.getNumResults() != null && other.getNumResults().equals(this.getNumResults()) == false) return false; if (other.getJobInput() == null ^ this.getJobInput() == null) return false; if (other.getJobInput() != null && other.getJobInput().equals(this.getJobInput()) == false) return false; if (other.getJobOutput() == null ^ this.getJobOutput() == null) return false; if (other.getJobOutput() != null && other.getJobOutput().equals(this.getJobOutput()) == false) return false; if (other.getBatchInferenceJobConfig() == null ^ this.getBatchInferenceJobConfig() == null) return false; if (other.getBatchInferenceJobConfig() != null && other.getBatchInferenceJobConfig().equals(this.getBatchInferenceJobConfig()) == false) return false; if (other.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getBatchInferenceJobMode() == null ^ this.getBatchInferenceJobMode() == null) return false; if (other.getBatchInferenceJobMode() != null && other.getBatchInferenceJobMode().equals(this.getBatchInferenceJobMode()) == false) return false; if (other.getThemeGenerationConfig() == null ^ this.getThemeGenerationConfig() == null) return false; if (other.getThemeGenerationConfig() != null && other.getThemeGenerationConfig().equals(this.getThemeGenerationConfig()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getCreationDateTime() == null ^ this.getCreationDateTime() == null) return false; if (other.getCreationDateTime() != null && other.getCreationDateTime().equals(this.getCreationDateTime()) == false) return false; if (other.getLastUpdatedDateTime() == null ^ this.getLastUpdatedDateTime() == null) return false; if (other.getLastUpdatedDateTime() != null && other.getLastUpdatedDateTime().equals(this.getLastUpdatedDateTime()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getJobName() == null) ? 0 : getJobName().hashCode()); hashCode = prime * hashCode + ((getBatchInferenceJobArn() == null) ? 0 : getBatchInferenceJobArn().hashCode()); hashCode = prime * hashCode + ((getFilterArn() == null) ? 0 : getFilterArn().hashCode()); hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode()); hashCode = prime * hashCode + ((getSolutionVersionArn() == null) ? 0 : getSolutionVersionArn().hashCode()); hashCode = prime * hashCode + ((getNumResults() == null) ? 0 : getNumResults().hashCode()); hashCode = prime * hashCode + ((getJobInput() == null) ? 0 : getJobInput().hashCode()); hashCode = prime * hashCode + ((getJobOutput() == null) ? 0 : getJobOutput().hashCode()); hashCode = prime * hashCode + ((getBatchInferenceJobConfig() == null) ? 0 : getBatchInferenceJobConfig().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getBatchInferenceJobMode() == null) ? 0 : getBatchInferenceJobMode().hashCode()); hashCode = prime * hashCode + ((getThemeGenerationConfig() == null) ? 0 : getThemeGenerationConfig().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getCreationDateTime() == null) ? 0 : getCreationDateTime().hashCode()); hashCode = prime * hashCode + ((getLastUpdatedDateTime() == null) ? 0 : getLastUpdatedDateTime().hashCode()); return hashCode; } @Override public BatchInferenceJob clone() { try { return (BatchInferenceJob) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.personalize.model.transform.BatchInferenceJobMarshaller.getInstance().marshall(this, protocolMarshaller); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy