com.amazonaws.services.kendraranking.model

Class CreateRescoreExecutionPlanRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendraranking.model.CreateRescoreExecutionPlanRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateRescoreExecutionPlanRequest()

Method Summary

Modifier and Type	Method and Description
CreateRescoreExecutionPlanRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
CapacityUnitsConfiguration	getCapacityUnits() You can set additional capacity units to meet the needs of your rescore execution plan.
String	getClientToken() A token that you provide to identify the request to create a rescore execution plan.
String	getDescription() A description for the rescore execution plan.
String	getName() A name for the rescore execution plan.
List<Tag>	getTags() A list of key-value pairs that identify or categorize your rescore execution plan.
int	hashCode()
void	setCapacityUnits(CapacityUnitsConfiguration capacityUnits) You can set additional capacity units to meet the needs of your rescore execution plan.
void	setClientToken(String clientToken) A token that you provide to identify the request to create a rescore execution plan.
void	setDescription(String description) A description for the rescore execution plan.
void	setName(String name) A name for the rescore execution plan.
void	setTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize your rescore execution plan.
String	toString() Returns a string representation of this object.
CreateRescoreExecutionPlanRequest	withCapacityUnits(CapacityUnitsConfiguration capacityUnits) You can set additional capacity units to meet the needs of your rescore execution plan.
CreateRescoreExecutionPlanRequest	withClientToken(String clientToken) A token that you provide to identify the request to create a rescore execution plan.
CreateRescoreExecutionPlanRequest	withDescription(String description) A description for the rescore execution plan.
CreateRescoreExecutionPlanRequest	withName(String name) A name for the rescore execution plan.
CreateRescoreExecutionPlanRequest	withTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize your rescore execution plan.
CreateRescoreExecutionPlanRequest	withTags(Tag... tags) A list of key-value pairs that identify or categorize your rescore execution plan.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRescoreExecutionPlanRequest

public CreateRescoreExecutionPlanRequest()

Method Detail

setName

public void setName(String name)

A name for the rescore execution plan.

Parameters:

name - A name for the rescore execution plan.

getName

public String getName()

A name for the rescore execution plan.

Returns:

A name for the rescore execution plan.

withName

public CreateRescoreExecutionPlanRequest withName(String name)

A name for the rescore execution plan.

Parameters:

name - A name for the rescore execution plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description for the rescore execution plan.

Parameters:

description - A description for the rescore execution plan.

getDescription

public String getDescription()

A description for the rescore execution plan.

Returns:

A description for the rescore execution plan.

withDescription

public CreateRescoreExecutionPlanRequest withDescription(String description)

A description for the rescore execution plan.

Parameters:

description - A description for the rescore execution plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCapacityUnits

public void setCapacityUnits(CapacityUnitsConfiguration 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.

Parameters:

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.

getCapacityUnits

public CapacityUnitsConfiguration getCapacityUnits()

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.

Returns:

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.

withCapacityUnits

public CreateRescoreExecutionPlanRequest withCapacityUnits(CapacityUnitsConfiguration 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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: _ . : / = + - @.

Returns:

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: _ . : / = + - @.

setTags

public void setTags(Collection<Tag> 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: _ . : / = + - @.

Parameters:

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: _ . : / = + - @.

withTags

public CreateRescoreExecutionPlanRequest withTags(Tag... 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 setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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: _ . : / = + - @.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateRescoreExecutionPlanRequest withTags(Collection<Tag> 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: _ . : / = + - @.

Parameters:

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: _ . : / = + - @.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String 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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

Returns:

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.

withClientToken

public CreateRescoreExecutionPlanRequest withClientToken(String 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.

Parameters:

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.

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 CreateRescoreExecutionPlanRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()