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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateIndexRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`applicationId()`	The identifier of the Amazon Q Business application using the index.
`static CreateIndexRequest.Builder`	`builder()`
`IndexCapacityConfiguration`	`capacityConfiguration()`	The capacity units you want to provision for your index.
`String`	`clientToken()`	A token that you provide to identify the request to create an index.
`String`	`description()`	A description for the Amazon Q Business index.
`String`	`displayName()`	A name for the Amazon Q Business index.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateIndexRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	A list of key-value pairs that identify or categorize the index.
`CreateIndexRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`IndexType`	`type()`	The index type that's suitable for your needs.
`String`	`typeAsString()`	The index type that's suitable for your needs.

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 Business application using the index.
    
    Returns:
    
    The identifier of the Amazon Q Business application using the index.
  - displayName
```
public final String displayName()
```
    A name for the Amazon Q Business index.
    
    Returns:
    
    A name for the Amazon Q Business index.
  - type
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, type will return IndexType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    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
  - typeAsString
```
public final String typeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, type will return IndexType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    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
  - description
```
public final String description()
```
    A description for the Amazon Q Business index.
    
    Returns:
    
    A description for the Amazon Q Business index.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<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: _ . : / = + - @.
    
    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 hasTags() method.
    
    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: _ . : / = + - @.
  - capacityConfiguration
```
public final IndexCapacityConfiguration capacityConfiguration()
```
    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.
  - clientToken
```
public final 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.
    
    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.
  - toBuilder
```
public CreateIndexRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>
    
    Specified by:
    
    toBuilder in class QBusinessRequest
  - builder
```
public static CreateIndexRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateIndexRequest.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

Class CreateIndexRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

applicationId

displayName

type

typeAsString

description

hasTags

tags

capacityConfiguration

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields