com.amazonaws.services.kendraranking.model.CreateRescoreExecutionPlanRequest 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateRescoreExecutionPlanRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A name for the rescore execution plan.
*
*/
private String name;
/**
*
* A description for the rescore execution plan.
*
*/
private String description;
/**
*
* You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single
* capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For
* more information on the default capacity and additional capacity units, see Adjusting capacity.
*
*/
private CapacityUnitsConfiguration capacityUnits;
/**
*
* A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help
* control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols: _ . : / = + - @.
*
*/
private java.util.List tags;
/**
*
* A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the
* CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore
* execution plan.
*
*/
private String clientToken;
/**
*
* A name for the rescore execution plan.
*
*
* @param name
* A name for the rescore execution plan.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A name for the rescore execution plan.
*
*
* @return A name for the rescore execution plan.
*/
public String getName() {
return this.name;
}
/**
*
* A name for the rescore execution plan.
*
*
* @param name
* A name for the rescore execution plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRescoreExecutionPlanRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A description for the rescore execution plan.
*
*
* @param description
* A description for the rescore execution plan.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description for the rescore execution plan.
*
*
* @return A description for the rescore execution plan.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description for the rescore execution plan.
*
*
* @param description
* A description for the rescore execution plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRescoreExecutionPlanRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single
* capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For
* more information on the default capacity and additional capacity units, see Adjusting capacity.
*
*
* @param capacityUnits
* You can set additional capacity units to meet the needs of your rescore execution plan. You are given a
* single capacity unit by default. If you want to use the default capacity, you don't set additional
* capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.
*/
public void setCapacityUnits(CapacityUnitsConfiguration capacityUnits) {
this.capacityUnits = capacityUnits;
}
/**
*
* You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single
* capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For
* more information on the default capacity and additional capacity units, see Adjusting capacity.
*
*
* @return You can set additional capacity units to meet the needs of your rescore execution plan. You are given a
* single capacity unit by default. If you want to use the default capacity, you don't set additional
* capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.
*/
public CapacityUnitsConfiguration getCapacityUnits() {
return this.capacityUnits;
}
/**
*
* You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single
* capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For
* more information on the default capacity and additional capacity units, see Adjusting capacity.
*
*
* @param capacityUnits
* You can set additional capacity units to meet the needs of your rescore execution plan. You are given a
* single capacity unit by default. If you want to use the default capacity, you don't set additional
* capacity units. 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 CreateRescoreExecutionPlanRequest withCapacityUnits(CapacityUnitsConfiguration capacityUnits) {
setCapacityUnits(capacityUnits);
return this;
}
/**
*
* A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help
* control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols: _ . : / = + - @.
*
*
* @return A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags
* to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters,
* digits, white space, and any of the following symbols: _ . : / = + - @.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help
* control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols: _ . : / = + - @.
*
*
* @param tags
* A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags
* to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters,
* digits, white space, and any of the following symbols: _ . : / = + - @.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help
* control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols: _ . : / = + - @.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags
* to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters,
* digits, white space, and any of the following symbols: _ . : / = + - @.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRescoreExecutionPlanRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help
* control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols: _ . : / = + - @.
*
*
* @param tags
* A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags
* to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters,
* digits, white space, and any of the following symbols: _ . : / = + - @.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRescoreExecutionPlanRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the
* CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore
* execution plan.
*
*
* @param clientToken
* A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the
* CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore
* execution plan.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the
* CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore
* execution plan.
*
*
* @return A token that you provide to identify the request to create a rescore execution plan. Multiple calls to
* the CreateRescoreExecutionPlanRequest API with the same client token will create only one
* rescore execution plan.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the
* CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore
* execution plan.
*
*
* @param clientToken
* A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the
* CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore
* execution plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRescoreExecutionPlanRequest withClientToken(String clientToken) {
setClientToken(clientToken);
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 (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 (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateRescoreExecutionPlanRequest == false)
return false;
CreateRescoreExecutionPlanRequest other = (CreateRescoreExecutionPlanRequest) obj;
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.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
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 + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public CreateRescoreExecutionPlanRequest clone() {
return (CreateRescoreExecutionPlanRequest) super.clone();
}
}