DescribeQuerySuggestionsBlockListResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kendra.model.DescribeQuerySuggestionsBlockListResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeQuerySuggestionsBlockListResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeQuerySuggestionsBlockListResult()

Constructors
Constructor and Description
`DescribeQuerySuggestionsBlockListResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeQuerySuggestionsBlockListResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedAt()` Shows the date-time a block list for query suggestions was created.
`String`	`getDescription()` Shows the description for the block list.
`String`	`getErrorMessage()` Shows the error message with details when there are issues in processing the block list.
`Long`	`getFileSizeBytes()` Shows the current size of the block list text file in S3.
`String`	`getId()` Shows the unique identifier of the block list.
`String`	`getIndexId()` Shows the identifier of the index for the block list.
`Integer`	`getItemCount()` Shows the current number of valid, non-empty words or phrases in the block list text file.
`String`	`getName()` Shows the name of the block list.
`String`	`getRoleArn()` Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
`S3Path`	`getSourceS3Path()` Shows the current S3 path to your block list text file in your S3 bucket.
`String`	`getStatus()` Shows whether the current status of the block list is `ACTIVE` or `INACTIVE`.
`Date`	`getUpdatedAt()` Shows the date-time a block list for query suggestions was last updated.
`int`	`hashCode()`
`void`	`setCreatedAt(Date createdAt)` Shows the date-time a block list for query suggestions was created.
`void`	`setDescription(String description)` Shows the description for the block list.
`void`	`setErrorMessage(String errorMessage)` Shows the error message with details when there are issues in processing the block list.
`void`	`setFileSizeBytes(Long fileSizeBytes)` Shows the current size of the block list text file in S3.
`void`	`setId(String id)` Shows the unique identifier of the block list.
`void`	`setIndexId(String indexId)` Shows the identifier of the index for the block list.
`void`	`setItemCount(Integer itemCount)` Shows the current number of valid, non-empty words or phrases in the block list text file.
`void`	`setName(String name)` Shows the name of the block list.
`void`	`setRoleArn(String roleArn)` Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
`void`	`setSourceS3Path(S3Path sourceS3Path)` Shows the current S3 path to your block list text file in your S3 bucket.
`void`	`setStatus(String status)` Shows whether the current status of the block list is `ACTIVE` or `INACTIVE`.
`void`	`setUpdatedAt(Date updatedAt)` Shows the date-time a block list for query suggestions was last updated.
`String`	`toString()` Returns a string representation of this object.
`DescribeQuerySuggestionsBlockListResult`	`withCreatedAt(Date createdAt)` Shows the date-time a block list for query suggestions was created.
`DescribeQuerySuggestionsBlockListResult`	`withDescription(String description)` Shows the description for the block list.
`DescribeQuerySuggestionsBlockListResult`	`withErrorMessage(String errorMessage)` Shows the error message with details when there are issues in processing the block list.
`DescribeQuerySuggestionsBlockListResult`	`withFileSizeBytes(Long fileSizeBytes)` Shows the current size of the block list text file in S3.
`DescribeQuerySuggestionsBlockListResult`	`withId(String id)` Shows the unique identifier of the block list.
`DescribeQuerySuggestionsBlockListResult`	`withIndexId(String indexId)` Shows the identifier of the index for the block list.
`DescribeQuerySuggestionsBlockListResult`	`withItemCount(Integer itemCount)` Shows the current number of valid, non-empty words or phrases in the block list text file.
`DescribeQuerySuggestionsBlockListResult`	`withName(String name)` Shows the name of the block list.
`DescribeQuerySuggestionsBlockListResult`	`withRoleArn(String roleArn)` Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
`DescribeQuerySuggestionsBlockListResult`	`withSourceS3Path(S3Path sourceS3Path)` Shows the current S3 path to your block list text file in your S3 bucket.
`DescribeQuerySuggestionsBlockListResult`	`withStatus(QuerySuggestionsBlockListStatus status)` Shows whether the current status of the block list is `ACTIVE` or `INACTIVE`.
`DescribeQuerySuggestionsBlockListResult`	`withStatus(String status)` Shows whether the current status of the block list is `ACTIVE` or `INACTIVE`.
`DescribeQuerySuggestionsBlockListResult`	`withUpdatedAt(Date updatedAt)` Shows the date-time a block list for query suggestions was last updated.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeQuerySuggestionsBlockListResult
```
public DescribeQuerySuggestionsBlockListResult()
```
- Method Detail
  - setIndexId
```
public void setIndexId(String indexId)
```
    Shows the identifier of the index for the block list.
    
    Parameters:
    
    indexId - Shows the identifier of the index for the block list.
  - getIndexId
```
public String getIndexId()
```
    Shows the identifier of the index for the block list.
    
    Returns:
    
    Shows the identifier of the index for the block list.
  - withIndexId
```
public DescribeQuerySuggestionsBlockListResult withIndexId(String indexId)
```
    Shows the identifier of the index for the block list.
    
    Parameters:
    
    indexId - Shows the identifier of the index for the block list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    Shows the unique identifier of the block list.
    
    Parameters:
    
    id - Shows the unique identifier of the block list.
  - getId
```
public String getId()
```
    Shows the unique identifier of the block list.
    
    Returns:
    
    Shows the unique identifier of the block list.
  - withId
```
public DescribeQuerySuggestionsBlockListResult withId(String id)
```
    Shows the unique identifier of the block list.
    
    Parameters:
    
    id - Shows the unique identifier of the block list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    Shows the name of the block list.
    
    Parameters:
    
    name - Shows the name of the block list.
  - getName
```
public String getName()
```
    Shows the name of the block list.
    
    Returns:
    
    Shows the name of the block list.
  - withName
```
public DescribeQuerySuggestionsBlockListResult withName(String name)
```
    Shows the name of the block list.
    
    Parameters:
    
    name - Shows the name of the block list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Shows the description for the block list.
    
    Parameters:
    
    description - Shows the description for the block list.
  - getDescription
```
public String getDescription()
```
    Shows the description for the block list.
    
    Returns:
    
    Shows the description for the block list.
  - withDescription
```
public DescribeQuerySuggestionsBlockListResult withDescription(String description)
```
    Shows the description for the block list.
    
    Parameters:
    
    description - Shows the description for the block list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Shows whether the current status of the block list is ACTIVE or INACTIVE.
    
    Parameters:
    
    status - Shows whether the current status of the block list is ACTIVE or INACTIVE.
    
    See Also:
    
    QuerySuggestionsBlockListStatus
  - getStatus
```
public String getStatus()
```
    Shows whether the current status of the block list is ACTIVE or INACTIVE.
    
    Returns:
    
    Shows whether the current status of the block list is ACTIVE or INACTIVE.
    
    See Also:
    
    QuerySuggestionsBlockListStatus
  - withStatus
```
public DescribeQuerySuggestionsBlockListResult withStatus(String status)
```
    Shows whether the current status of the block list is ACTIVE or INACTIVE.
    
    Parameters:
    
    status - Shows whether the current status of the block list is ACTIVE or INACTIVE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QuerySuggestionsBlockListStatus
  - withStatus
```
public DescribeQuerySuggestionsBlockListResult withStatus(QuerySuggestionsBlockListStatus status)
```
    Shows whether the current status of the block list is ACTIVE or INACTIVE.
    
    Parameters:
    
    status - Shows whether the current status of the block list is ACTIVE or INACTIVE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QuerySuggestionsBlockListStatus
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    Shows the error message with details when there are issues in processing the block list.
    
    Parameters:
    
    errorMessage - Shows the error message with details when there are issues in processing the block list.
  - getErrorMessage
```
public String getErrorMessage()
```
    Shows the error message with details when there are issues in processing the block list.
    
    Returns:
    
    Shows the error message with details when there are issues in processing the block list.
  - withErrorMessage
```
public DescribeQuerySuggestionsBlockListResult withErrorMessage(String errorMessage)
```
    Shows the error message with details when there are issues in processing the block list.
    
    Parameters:
    
    errorMessage - Shows the error message with details when there are issues in processing the block list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    Shows the date-time a block list for query suggestions was created.
    
    Parameters:
    
    createdAt - Shows the date-time a block list for query suggestions was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    Shows the date-time a block list for query suggestions was created.
    
    Returns:
    
    Shows the date-time a block list for query suggestions was created.
  - withCreatedAt
```
public DescribeQuerySuggestionsBlockListResult withCreatedAt(Date createdAt)
```
    Shows the date-time a block list for query suggestions was created.
    
    Parameters:
    
    createdAt - Shows the date-time a block list for query suggestions was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    Shows the date-time a block list for query suggestions was last updated.
    
    Parameters:
    
    updatedAt - Shows the date-time a block list for query suggestions was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    Shows the date-time a block list for query suggestions was last updated.
    
    Returns:
    
    Shows the date-time a block list for query suggestions was last updated.
  - withUpdatedAt
```
public DescribeQuerySuggestionsBlockListResult withUpdatedAt(Date updatedAt)
```
    Shows the date-time a block list for query suggestions was last updated.
    
    Parameters:
    
    updatedAt - Shows the date-time a block list for query suggestions was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceS3Path
```
public void setSourceS3Path(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.
    
    Parameters:
    
    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.
  - getSourceS3Path
```
public S3Path getSourceS3Path()
```
    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.
  - withSourceS3Path
```
public DescribeQuerySuggestionsBlockListResult withSourceS3Path(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setItemCount
```
public void setItemCount(Integer itemCount)
```
    Shows the current number of valid, non-empty words or phrases in the block list text file.
    
    Parameters:
    
    itemCount - Shows the current number of valid, non-empty words or phrases in the block list text file.
  - getItemCount
```
public Integer getItemCount()
```
    Shows the current number of valid, non-empty words or phrases in the block list text file.
    
    Returns:
    
    Shows the current number of valid, non-empty words or phrases in the block list text file.
  - withItemCount
```
public DescribeQuerySuggestionsBlockListResult withItemCount(Integer itemCount)
```
    Shows the current number of valid, non-empty words or phrases in the block list text file.
    
    Parameters:
    
    itemCount - Shows the current number of valid, non-empty words or phrases in the block list text file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileSizeBytes
```
public void setFileSizeBytes(Long fileSizeBytes)
```
    Shows the current size of the block list text file in S3.
    
    Parameters:
    
    fileSizeBytes - Shows the current size of the block list text file in S3.
  - getFileSizeBytes
```
public Long getFileSizeBytes()
```
    Shows the current size of the block list text file in S3.
    
    Returns:
    
    Shows the current size of the block list text file in S3.
  - withFileSizeBytes
```
public DescribeQuerySuggestionsBlockListResult withFileSizeBytes(Long fileSizeBytes)
```
    Shows the current size of the block list text file in S3.
    
    Parameters:
    
    fileSizeBytes - Shows the current size of the block list text file in S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    Shows the current 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.
    
    Parameters:
    
    roleArn - Shows the current 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.
  - getRoleArn
```
public String getRoleArn()
```
    Shows the current 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:
    
    Shows the current 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.
  - withRoleArn
```
public DescribeQuerySuggestionsBlockListResult withRoleArn(String roleArn)
```
    Shows the current 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.
    
    Parameters:
    
    roleArn - Shows the current 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeQuerySuggestionsBlockListResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeQuerySuggestionsBlockListResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeQuerySuggestionsBlockListResult

Method Detail

setIndexId

getIndexId

withIndexId

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

withStatus

setErrorMessage

getErrorMessage

withErrorMessage

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setSourceS3Path

getSourceS3Path

withSourceS3Path

setItemCount

getItemCount

withItemCount

setFileSizeBytes

getFileSizeBytes

withFileSizeBytes

setRoleArn

getRoleArn

withRoleArn

toString

equals

hashCode

clone