com.amazonaws.services.qbusiness.model

Class CreateIndexRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qbusiness.model.CreateIndexRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateIndexRequest
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
CreateIndexRequest()

Method Summary

Modifier and Type	Method and Description
CreateIndexRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApplicationId() The identifier of the Amazon Q Business application using the index.
IndexCapacityConfiguration	getCapacityConfiguration() The capacity units you want to provision for your index.
String	getClientToken() A token that you provide to identify the request to create an index.
String	getDescription() A description for the Amazon Q Business index.
String	getDisplayName() A name for the Amazon Q Business index.
List<Tag>	getTags() A list of key-value pairs that identify or categorize the index.
String	getType() The index type that's suitable for your needs.
int	hashCode()
void	setApplicationId(String applicationId) The identifier of the Amazon Q Business application using the index.
void	setCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration) The capacity units you want to provision for your index.
void	setClientToken(String clientToken) A token that you provide to identify the request to create an index.
void	setDescription(String description) A description for the Amazon Q Business index.
void	setDisplayName(String displayName) A name for the Amazon Q Business index.
void	setTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the index.
void	setType(String type) The index type that's suitable for your needs.
String	toString() Returns a string representation of this object.
CreateIndexRequest	withApplicationId(String applicationId) The identifier of the Amazon Q Business application using the index.
CreateIndexRequest	withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration) The capacity units you want to provision for your index.
CreateIndexRequest	withClientToken(String clientToken) A token that you provide to identify the request to create an index.
CreateIndexRequest	withDescription(String description) A description for the Amazon Q Business index.
CreateIndexRequest	withDisplayName(String displayName) A name for the Amazon Q Business index.
CreateIndexRequest	withTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the index.
CreateIndexRequest	withTags(Tag... tags) A list of key-value pairs that identify or categorize the index.
CreateIndexRequest	withType(IndexType type) The index type that's suitable for your needs.
CreateIndexRequest	withType(String type) The index type that's suitable for your needs.

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

CreateIndexRequest

public CreateIndexRequest()

Method Detail

setApplicationId

public void setApplicationId(String applicationId)

The identifier of the Amazon Q Business application using the index.

Parameters:

applicationId - The identifier of the Amazon Q Business application using the index.

getApplicationId

public String getApplicationId()

The identifier of the Amazon Q Business application using the index.

Returns:

The identifier of the Amazon Q Business application using the index.

withApplicationId

public CreateIndexRequest withApplicationId(String applicationId)

The identifier of the Amazon Q Business application using the index.

Parameters:

applicationId - The identifier of the Amazon Q Business application using the index.

Returns:

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

setDisplayName

public void setDisplayName(String displayName)

A name for the Amazon Q Business index.

Parameters:

displayName - A name for the Amazon Q Business index.

getDisplayName

public String getDisplayName()

A name for the Amazon Q Business index.

Returns:

A name for the Amazon Q Business index.

withDisplayName

public CreateIndexRequest withDisplayName(String displayName)

A name for the Amazon Q Business index.

Parameters:

displayName - A name for the Amazon Q Business index.

Returns:

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

setType

public void setType(String type)

The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

Parameters:

type - The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

See Also:

IndexType

getType

public String getType()

The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

Returns:

The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

See Also:

IndexType

withType

public CreateIndexRequest withType(String type)

The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

Parameters:

type - The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

Returns:

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

See Also:

IndexType

withType

public CreateIndexRequest withType(IndexType type)

The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

Parameters:

type - The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

Returns:

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

See Also:

IndexType

setDescription

public void setDescription(String description)

A description for the Amazon Q Business index.

Parameters:

description - A description for the Amazon Q Business index.

getDescription

public String getDescription()

A description for the Amazon Q Business index.

Returns:

A description for the Amazon Q Business index.

withDescription

public CreateIndexRequest withDescription(String description)

A description for the Amazon Q Business index.

Parameters:

description - A description for the Amazon Q Business index.

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 the index. You can also use tags to help control access to the index. 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 the index. You can also use tags to help control access to the index. 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 the index. You can also use tags to help control access to the index. 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 the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

withTags

public CreateIndexRequest withTags(Tag... tags)

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. 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 the index. You can also use tags to help control access to the index. 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 CreateIndexRequest withTags(Collection<Tag> tags)

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. 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 the index. You can also use tags to help control access to the index. 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.

setCapacityConfiguration

public void setCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

Parameters:

capacityConfiguration - The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

getCapacityConfiguration

public IndexCapacityConfiguration getCapacityConfiguration()

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

Returns:

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

withCapacityConfiguration

public CreateIndexRequest withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

Parameters:

capacityConfiguration - The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

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 an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Parameters:

clientToken - A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

getClientToken

public String getClientToken()

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Returns:

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

withClientToken

public CreateIndexRequest withClientToken(String clientToken)

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Parameters:

clientToken - A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

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 CreateIndexRequest 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()