DescribeQuerySuggestionsBlockListResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.kendra.model.KendraResponse
    - - software.amazon.awssdk.services.kendra.model.DescribeQuerySuggestionsBlockListResponse

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

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeQuerySuggestionsBlockListResponse
extends KendraResponse
implements ToCopyableBuilder<DescribeQuerySuggestionsBlockListResponse.Builder,DescribeQuerySuggestionsBlockListResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeQuerySuggestionsBlockListResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeQuerySuggestionsBlockListResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeQuerySuggestionsBlockListResponse.Builder`	`builder()`
`Instant`	`createdAt()` The Unix timestamp when a block list for query suggestions was created.
`String`	`description()` The description for the block list.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorMessage()` The error message containing details if there are issues processing the block list.
`Long`	`fileSizeBytes()` The current size of the block list text file in S3.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The identifier of the block list.
`String`	`indexId()` The identifier of the index for the block list.
`Integer`	`itemCount()` The current number of valid, non-empty words or phrases in the block list text file.
`String`	`name()` The name of the block list.
`String`	`roleArn()` The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeQuerySuggestionsBlockListResponse.Builder>`	`serializableBuilderClass()`
`S3Path`	`sourceS3Path()` Shows the current S3 path to your block list text file in your S3 bucket.
`QuerySuggestionsBlockListStatus`	`status()` The current status of the block list.
`String`	`statusAsString()` The current status of the block list.
`DescribeQuerySuggestionsBlockListResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`updatedAt()` The Unix timestamp when a block list for query suggestions was last updated.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - indexId
```
public final String indexId()
```
    The identifier of the index for the block list.
    
    Returns:
    
    The identifier of the index for the block list.
  - id
```
public final String id()
```
    The identifier of the block list.
    
    Returns:
    
    The identifier of the block list.
  - name
```
public final String name()
```
    The name of the block list.
    
    Returns:
    
    The name of the block list.
  - description
```
public final String description()
```
    The description for the block list.
    
    Returns:
    
    The description for the block list.
  - status
```
public final QuerySuggestionsBlockListStatus status()
```
    The current status of the block list. When the value is ACTIVE, the block list is ready for use.
    
    If the service returns an enum value that is not available in the current SDK version, status will return QuerySuggestionsBlockListStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the block list. When the value is ACTIVE, the block list is ready for use.
    
    See Also:
    
    QuerySuggestionsBlockListStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the block list. When the value is ACTIVE, the block list is ready for use.
    
    If the service returns an enum value that is not available in the current SDK version, status will return QuerySuggestionsBlockListStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the block list. When the value is ACTIVE, the block list is ready for use.
    
    See Also:
    
    QuerySuggestionsBlockListStatus
  - errorMessage
```
public final String errorMessage()
```
    The error message containing details if there are issues processing the block list.
    
    Returns:
    
    The error message containing details if there are issues processing the block list.
  - createdAt
```
public final Instant createdAt()
```
    The Unix timestamp when a block list for query suggestions was created.
    
    Returns:
    
    The Unix timestamp when a block list for query suggestions was created.
  - updatedAt
```
public final Instant updatedAt()
```
    The Unix timestamp when a block list for query suggestions was last updated.
    
    Returns:
    
    The Unix timestamp when a block list for query suggestions was last updated.
  - sourceS3Path
```
public final S3Path sourceS3Path()
```
    Shows the current S3 path to your block list text file in your S3 bucket.
    
    Each block word or phrase should be on a separate line in a text file.
    
    For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
    
    Returns:
    
    Shows the current S3 path to your block list text file in your S3 bucket.
    
    Each block word or phrase should be on a separate line in a text file.
    
    For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
  - itemCount
```
public final Integer itemCount()
```
    The current number of valid, non-empty words or phrases in the block list text file.
    
    Returns:
    
    The current number of valid, non-empty words or phrases in the block list text file.
  - fileSizeBytes
```
public final Long fileSizeBytes()
```
    The current size of the block list text file in S3.
    
    Returns:
    
    The current size of the block list text file in S3.
  - roleArn
```
public final String roleArn()
```
    The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
    
    The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
    
    Returns:
    
    The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
    
    The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
  - toBuilder
```
public DescribeQuerySuggestionsBlockListResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeQuerySuggestionsBlockListResponse.Builder,DescribeQuerySuggestionsBlockListResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeQuerySuggestionsBlockListResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeQuerySuggestionsBlockListResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeQuerySuggestionsBlockListResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

indexId

id

name

description

status

statusAsString

errorMessage

createdAt

updatedAt

sourceS3Path

itemCount

fileSizeBytes

roleArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields