Package software.amazon.awssdk.services.kendraranking.model

Class CreateRescoreExecutionPlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendraranking.model.KendraRankingRequest

software.amazon.awssdk.services.kendraranking.model.CreateRescoreExecutionPlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRescoreExecutionPlanRequest.Builder,CreateRescoreExecutionPlanRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateRescoreExecutionPlanRequest
extends KendraRankingRequest
implements ToCopyableBuilder<CreateRescoreExecutionPlanRequest.Builder,CreateRescoreExecutionPlanRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRescoreExecutionPlanRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateRescoreExecutionPlanRequest.Builder	builder()
CapacityUnitsConfiguration	capacityUnits()	You can set additional capacity units to meet the needs of your rescore execution plan.
String	clientToken()	A token that you provide to identify the request to create a rescore execution plan.
String	description()	A description for the rescore execution plan.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	A name for the rescore execution plan.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRescoreExecutionPlanRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of key-value pairs that identify or categorize your rescore execution plan.
CreateRescoreExecutionPlanRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

A name for the rescore execution plan.

Returns:

A name for the rescore execution plan.

description

public final String description()

A description for the rescore execution plan.

Returns:

A description for the rescore execution plan.

capacityUnits

public final 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.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

clientToken

public final 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.

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.

toBuilder

public CreateRescoreExecutionPlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRescoreExecutionPlanRequest.Builder,CreateRescoreExecutionPlanRequest>

Specified by:

toBuilder in class KendraRankingRequest

builder

public static CreateRescoreExecutionPlanRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRescoreExecutionPlanRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo