Class UpdateIndexRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateIndexRequest.Builder,
UpdateIndexRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The identifier of the Amazon Q Business application connected to the index.static UpdateIndexRequest.Builder
builder()
The storage capacity units you want to provision for your Amazon Q Business index.final String
The description of the Amazon Q Business index.final String
The name of the Amazon Q Business index.Configuration information for document metadata or fields.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DocumentAttributeConfigurations property.final int
hashCode()
final String
indexId()
The identifier of the Amazon Q Business index.static Class
<? extends UpdateIndexRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The identifier of the Amazon Q Business application connected to the index.
- Returns:
- The identifier of the Amazon Q Business application connected to the index.
-
indexId
The identifier of the Amazon Q Business index.
- Returns:
- The identifier of the Amazon Q Business index.
-
displayName
The name of the Amazon Q Business index.
- Returns:
- The name of the Amazon Q Business index.
-
description
The description of the Amazon Q Business index.
- Returns:
- The description of the Amazon Q Business index.
-
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.
- Returns:
- 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.
-
hasDocumentAttributeConfigurations
public final boolean hasDocumentAttributeConfigurations()For responses, this returns true if the service returned a value for the DocumentAttributeConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasDocumentAttributeConfigurations()
method.- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateIndexRequest.Builder,
UpdateIndexRequest> - Specified by:
toBuilder
in classQBusinessRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-