@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateIndexRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateIndexRequest() |
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 Business application connected to the index.
|
IndexCapacityConfiguration |
getCapacityConfiguration()
The storage capacity units you want to provision for your Amazon Q Business index.
|
String |
getDescription()
The description of the Amazon Q Business index.
|
String |
getDisplayName()
The name of the Amazon Q Business index.
|
List<DocumentAttributeConfiguration> |
getDocumentAttributeConfigurations()
Configuration information for document metadata or fields.
|
String |
getIndexId()
The identifier of the Amazon Q Business index.
|
int |
hashCode() |
void |
setApplicationId(String applicationId)
The identifier of the Amazon Q Business application connected to the index.
|
void |
setCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)
The storage capacity units you want to provision for your Amazon Q Business index.
|
void |
setDescription(String description)
The description of the Amazon Q Business index.
|
void |
setDisplayName(String displayName)
The name of the Amazon Q Business index.
|
void |
setDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)
Configuration information for document metadata or fields.
|
void |
setIndexId(String indexId)
The identifier of the Amazon Q Business index.
|
String |
toString()
Returns a string representation of this object.
|
UpdateIndexRequest |
withApplicationId(String applicationId)
The identifier of the Amazon Q Business application connected to the index.
|
UpdateIndexRequest |
withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)
The storage capacity units you want to provision for your Amazon Q Business index.
|
UpdateIndexRequest |
withDescription(String description)
The description of the Amazon Q Business index.
|
UpdateIndexRequest |
withDisplayName(String displayName)
The name of the Amazon Q Business 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 Business index.
|
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
public void setApplicationId(String applicationId)
The identifier of the Amazon Q Business application connected to the index.
applicationId
- The identifier of the Amazon Q Business application connected to the index.public String getApplicationId()
The identifier of the Amazon Q Business application connected to the index.
public UpdateIndexRequest withApplicationId(String applicationId)
The identifier of the Amazon Q Business application connected to the index.
applicationId
- The identifier of the Amazon Q Business application connected to the index.public void setIndexId(String indexId)
The identifier of the Amazon Q Business index.
indexId
- The identifier of the Amazon Q Business index.public String getIndexId()
The identifier of the Amazon Q Business index.
public UpdateIndexRequest withIndexId(String indexId)
The identifier of the Amazon Q Business index.
indexId
- The identifier of the Amazon Q Business index.public void setDisplayName(String displayName)
The name of the Amazon Q Business index.
displayName
- The name of the Amazon Q Business index.public String getDisplayName()
The name of the Amazon Q Business index.
public UpdateIndexRequest withDisplayName(String displayName)
The name of the Amazon Q Business index.
displayName
- The name of the Amazon Q Business index.public void setDescription(String description)
The description of the Amazon Q Business index.
description
- The description of the Amazon Q Business index.public String getDescription()
The description of the Amazon Q Business index.
public UpdateIndexRequest withDescription(String description)
The description of the Amazon Q Business index.
description
- The description of the Amazon Q Business index.public void setCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)
The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.
capacityConfiguration
- The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove
capacity to fit your usage needs.public IndexCapacityConfiguration getCapacityConfiguration()
The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.
public UpdateIndexRequest withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)
The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.
capacityConfiguration
- The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove
capacity to fit your usage needs.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.
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.
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.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.
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.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.
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.public String toString()
toString
in class Object
Object.toString()
public UpdateIndexRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()