com.amazonaws.services.qbusiness.model

Class UpdateIndexRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qbusiness.model.UpdateIndexRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
UpdateIndexRequest	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 application connected to the index.
IndexCapacityConfiguration	getCapacityConfiguration() The storage capacity units you want to provision for your Amazon Q index.
String	getDescription() The description of the Amazon Q index.
String	getDisplayName() The name of the Amazon Q index.
List<DocumentAttributeConfiguration>	getDocumentAttributeConfigurations() Configuration information for document metadata or fields.
String	getIndexId() The identifier of the Amazon Q index.
int	hashCode()
void	setApplicationId(String applicationId) The identifier of the Amazon Q application connected to the index.
void	setCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration) The storage capacity units you want to provision for your Amazon Q index.
void	setDescription(String description) The description of the Amazon Q index.
void	setDisplayName(String displayName) The name of the Amazon Q index.
void	setDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations) Configuration information for document metadata or fields.
void	setIndexId(String indexId) The identifier of the Amazon Q index.
String	toString() Returns a string representation of this object.
UpdateIndexRequest	withApplicationId(String applicationId) The identifier of the Amazon Q application connected to the index.
UpdateIndexRequest	withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration) The storage capacity units you want to provision for your Amazon Q index.
UpdateIndexRequest	withDescription(String description) The description of the Amazon Q index.
UpdateIndexRequest	withDisplayName(String displayName) The name of the Amazon Q index.
UpdateIndexRequest	withDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations) Configuration information for document metadata or fields.
UpdateIndexRequest	withDocumentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations) Configuration information for document metadata or fields.
UpdateIndexRequest	withIndexId(String indexId) The identifier of the Amazon Q index.

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

UpdateIndexRequest

public UpdateIndexRequest()

Method Detail

setApplicationId

public void setApplicationId(String applicationId)

The identifier of the Amazon Q application connected to the index.

Parameters:

applicationId - The identifier of the Amazon Q application connected to the index.

getApplicationId

public String getApplicationId()

The identifier of the Amazon Q application connected to the index.

Returns:

The identifier of the Amazon Q application connected to the index.

withApplicationId

public UpdateIndexRequest withApplicationId(String applicationId)

The identifier of the Amazon Q application connected to the index.

Parameters:

applicationId - The identifier of the Amazon Q application connected to the index.

Returns:

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

setCapacityConfiguration

public void setCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)

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

Parameters:

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

getCapacityConfiguration

public IndexCapacityConfiguration getCapacityConfiguration()

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

Returns:

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

withCapacityConfiguration

public UpdateIndexRequest withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)

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

Parameters:

capacityConfiguration - The storage capacity units you want to provision for your Amazon Q 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.

setDescription

public void setDescription(String description)

The description of the Amazon Q index.

Parameters:

description - The description of the Amazon Q index.

getDescription

public String getDescription()

The description of the Amazon Q index.

Returns:

The description of the Amazon Q index.

withDescription

public UpdateIndexRequest withDescription(String description)

The description of the Amazon Q index.

Parameters:

description - The description of the Amazon Q index.

Returns:

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

setDisplayName

public void setDisplayName(String displayName)

The name of the Amazon Q index.

Parameters:

displayName - The name of the Amazon Q index.

getDisplayName

public String getDisplayName()

The name of the Amazon Q index.

Returns:

The name of the Amazon Q index.

withDisplayName

public UpdateIndexRequest withDisplayName(String displayName)

The name of the Amazon Q index.

Parameters:

displayName - The name of the Amazon Q index.

Returns:

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

getDocumentAttributeConfigurations

public List<DocumentAttributeConfiguration> getDocumentAttributeConfigurations()

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Returns:

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

setDocumentAttributeConfigurations

public void setDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Parameters:

documentAttributeConfigurations - Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

withDocumentAttributeConfigurations

public UpdateIndexRequest withDocumentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations)

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

NOTE: This method appends the values to the existing list (if any). Use setDocumentAttributeConfigurations(java.util.Collection) or withDocumentAttributeConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

documentAttributeConfigurations - Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Returns:

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

withDocumentAttributeConfigurations

public UpdateIndexRequest withDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Parameters:

documentAttributeConfigurations - Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Returns:

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

setIndexId

public void setIndexId(String indexId)

The identifier of the Amazon Q index.

Parameters:

indexId - The identifier of the Amazon Q index.

getIndexId

public String getIndexId()

The identifier of the Amazon Q index.

Returns:

The identifier of the Amazon Q index.

withIndexId

public UpdateIndexRequest withIndexId(String indexId)

The identifier of the Amazon Q index.

Parameters:

indexId - The identifier of the Amazon Q 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 UpdateIndexRequest 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()