Package software.amazon.awssdk.services.qbusiness.model

Class UpdateIndexRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qbusiness.model.QBusinessRequest

software.amazon.awssdk.services.qbusiness.model.UpdateIndexRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateIndexRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the Amazon Q application connected to the index.
static UpdateIndexRequest.Builder	builder()
IndexCapacityConfiguration	capacityConfiguration()	The storage capacity units you want to provision for your Amazon Q index.
String	description()	The description of the Amazon Q index.
String	displayName()	The name of the Amazon Q index.
List<DocumentAttributeConfiguration>	documentAttributeConfigurations()	Configuration information for document metadata or fields.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentAttributeConfigurations()	For responses, this returns true if the service returned a value for the DocumentAttributeConfigurations property.
int	hashCode()
String	indexId()	The identifier of the Amazon Q index.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateIndexRequest.Builder>	serializableBuilderClass()
UpdateIndexRequest.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

applicationId

public final String applicationId()

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

Returns:

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

capacityConfiguration

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

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.

description

public final String description()

The description of the Amazon Q index.

Returns:

The description of the Amazon Q index.

displayName

public final String displayName()

The name of the Amazon Q index.

Returns:

The name of the Amazon Q index.

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

documentAttributeConfigurations

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

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.

indexId

public final String indexId()

The identifier of the Amazon Q index.

Returns:

The identifier of the Amazon Q index.

toBuilder

public UpdateIndexRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static UpdateIndexRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateIndexRequest.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