com.amazonaws.services.kendraranking.model.DescribeRescoreExecutionPlanResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendraranking Show documentation
/*
* 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.kendraranking.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeRescoreExecutionPlanResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The identifier of the rescore execution plan.
*
*/
private String id;
/**
*
* The Amazon Resource Name (ARN) of the rescore execution plan.
*
*/
private String arn;
/**
*
* The name for the rescore execution plan.
*
*/
private String name;
/**
*
* The description for the rescore execution plan.
*
*/
private String description;
/**
*
* The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution
* plan is using the default capacity. For more information on the default capacity and additional capacity units,
* see Adjusting capacity.
*
*/
private CapacityUnitsConfiguration capacityUnits;
/**
*
* The Unix timestamp of when the rescore execution plan was created.
*
*/
private java.util.Date createdAt;
/**
*
* The Unix timestamp of when the rescore execution plan was last updated.
*
*/
private java.util.Date updatedAt;
/**
*
* The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution
* plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
*
*/
private String status;
/**
*
* When the Status field value is FAILED, the ErrorMessage field contains a
* message that explains why.
*
*/
private String errorMessage;
/**
*
* The identifier of the rescore execution plan.
*
*
* @param id
* The identifier of the rescore execution plan.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The identifier of the rescore execution plan.
*
*
* @return The identifier of the rescore execution plan.
*/
public String getId() {
return this.id;
}
/**
*
* The identifier of the rescore execution plan.
*
*
* @param id
* The identifier of the rescore execution plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRescoreExecutionPlanResult withId(String id) {
setId(id);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the rescore execution plan.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the rescore execution plan.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the rescore execution plan.
*
*
* @return The Amazon Resource Name (ARN) of the rescore execution plan.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the rescore execution plan.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the rescore execution plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRescoreExecutionPlanResult withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The name for the rescore execution plan.
*
*
* @param name
* The name for the rescore execution plan.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name for the rescore execution plan.
*
*
* @return The name for the rescore execution plan.
*/
public String getName() {
return this.name;
}
/**
*
* The name for the rescore execution plan.
*
*
* @param name
* The name for the rescore execution plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRescoreExecutionPlanResult withName(String name) {
setName(name);
return this;
}
/**
*
* The description for the rescore execution plan.
*
*
* @param description
* The description for the rescore execution plan.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description for the rescore execution plan.
*
*
* @return The description for the rescore execution plan.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description for the rescore execution plan.
*
*
* @param description
* The description for the rescore execution plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRescoreExecutionPlanResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution
* plan is using the default capacity. For more information on the default capacity and additional capacity units,
* see Adjusting capacity.
*
*
* @param capacityUnits
* The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore
* execution plan is using the default capacity. For more information on the default capacity and additional
* capacity units, see Adjusting capacity.
*/
public void setCapacityUnits(CapacityUnitsConfiguration capacityUnits) {
this.capacityUnits = capacityUnits;
}
/**
*
* The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution
* plan is using the default capacity. For more information on the default capacity and additional capacity units,
* see Adjusting capacity.
*
*
* @return The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore
* execution plan is using the default capacity. For more information on the default capacity and additional
* capacity units, see Adjusting capacity.
*/
public CapacityUnitsConfiguration getCapacityUnits() {
return this.capacityUnits;
}
/**
*
* The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution
* plan is using the default capacity. For more information on the default capacity and additional capacity units,
* see Adjusting capacity.
*
*
* @param capacityUnits
* The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore
* execution plan is using the default capacity. For more information on the default capacity and additional
* capacity units, see Adjusting capacity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRescoreExecutionPlanResult withCapacityUnits(CapacityUnitsConfiguration capacityUnits) {
setCapacityUnits(capacityUnits);
return this;
}
/**
*
* The Unix timestamp of when the rescore execution plan was created.
*
*
* @param createdAt
* The Unix timestamp of when the rescore execution plan was created.
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
*
* The Unix timestamp of when the rescore execution plan was created.
*
*
* @return The Unix timestamp of when the rescore execution plan was created.
*/
public java.util.Date getCreatedAt() {
return this.createdAt;
}
/**
*
* The Unix timestamp of when the rescore execution plan was created.
*
*
* @param createdAt
* The Unix timestamp of when the rescore execution plan was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRescoreExecutionPlanResult withCreatedAt(java.util.Date createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
*
* The Unix timestamp of when the rescore execution plan was last updated.
*
*
* @param updatedAt
* The Unix timestamp of when the rescore execution plan was last updated.
*/
public void setUpdatedAt(java.util.Date updatedAt) {
this.updatedAt = updatedAt;
}
/**
*
* The Unix timestamp of when the rescore execution plan was last updated.
*
*
* @return The Unix timestamp of when the rescore execution plan was last updated.
*/
public java.util.Date getUpdatedAt() {
return this.updatedAt;
}
/**
*
* The Unix timestamp of when the rescore execution plan was last updated.
*
*
* @param updatedAt
* The Unix timestamp of when the rescore execution plan was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRescoreExecutionPlanResult withUpdatedAt(java.util.Date updatedAt) {
setUpdatedAt(updatedAt);
return this;
}
/**
*
* The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution
* plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
*
*
* @param status
* The current status of the rescore execution plan. When the value is ACTIVE, the rescore
* execution plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
* @see RescoreExecutionPlanStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution
* plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
*
*
* @return The current status of the rescore execution plan. When the value is ACTIVE, the rescore
* execution plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
* @see RescoreExecutionPlanStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution
* plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
*
*
* @param status
* The current status of the rescore execution plan. When the value is ACTIVE, the rescore
* execution plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RescoreExecutionPlanStatus
*/
public DescribeRescoreExecutionPlanResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution
* plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
*
*
* @param status
* The current status of the rescore execution plan. When the value is ACTIVE, the rescore
* execution plan is ready for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RescoreExecutionPlanStatus
*/
public DescribeRescoreExecutionPlanResult withStatus(RescoreExecutionPlanStatus status) {
this.status = status.toString();
return this;
}
/**
*
* When the Status field value is FAILED, the ErrorMessage field contains a
* message that explains why.
*
*
* @param errorMessage
* When the Status field value is FAILED, the ErrorMessage field
* contains a message that explains why.
*/
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
/**
*
* When the Status field value is FAILED, the ErrorMessage field contains a
* message that explains why.
*
*
* @return When the Status field value is FAILED, the ErrorMessage field
* contains a message that explains why.
*/
public String getErrorMessage() {
return this.errorMessage;
}
/**
*
* When the Status field value is FAILED, the ErrorMessage field contains a
* message that explains why.
*
*
* @param errorMessage
* When the Status field value is FAILED, the ErrorMessage field
* contains a message that explains why.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRescoreExecutionPlanResult withErrorMessage(String errorMessage) {
setErrorMessage(errorMessage);
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 (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getCapacityUnits() != null)
sb.append("CapacityUnits: ").append(getCapacityUnits()).append(",");
if (getCreatedAt() != null)
sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
if (getUpdatedAt() != null)
sb.append("UpdatedAt: ").append(getUpdatedAt()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getErrorMessage() != null)
sb.append("ErrorMessage: ").append(getErrorMessage());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeRescoreExecutionPlanResult == false)
return false;
DescribeRescoreExecutionPlanResult other = (DescribeRescoreExecutionPlanResult) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getCapacityUnits() == null ^ this.getCapacityUnits() == null)
return false;
if (other.getCapacityUnits() != null && other.getCapacityUnits().equals(this.getCapacityUnits()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getUpdatedAt() == null ^ this.getUpdatedAt() == null)
return false;
if (other.getUpdatedAt() != null && other.getUpdatedAt().equals(this.getUpdatedAt()) == 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.getErrorMessage() == null ^ this.getErrorMessage() == null)
return false;
if (other.getErrorMessage() != null && other.getErrorMessage().equals(this.getErrorMessage()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getCapacityUnits() == null) ? 0 : getCapacityUnits().hashCode());
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode + ((getUpdatedAt() == null) ? 0 : getUpdatedAt().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getErrorMessage() == null) ? 0 : getErrorMessage().hashCode());
return hashCode;
}
@Override
public DescribeRescoreExecutionPlanResult clone() {
try {
return (DescribeRescoreExecutionPlanResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}