AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest Class Reference

#include <UpdateQuerySuggestionsBlockListRequest.h>

+ Inheritance diagram for Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest:

Public Member Functions

 UpdateQuerySuggestionsBlockListRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetIndexId () const
 
bool IndexIdHasBeenSet () const
 
void SetIndexId (const Aws::String &value)
 
void SetIndexId (Aws::String &&value)
 
void SetIndexId (const char *value)
 
UpdateQuerySuggestionsBlockListRequestWithIndexId (const Aws::String &value)
 
UpdateQuerySuggestionsBlockListRequestWithIndexId (Aws::String &&value)
 
UpdateQuerySuggestionsBlockListRequestWithIndexId (const char *value)
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
UpdateQuerySuggestionsBlockListRequestWithId (const Aws::String &value)
 
UpdateQuerySuggestionsBlockListRequestWithId (Aws::String &&value)
 
UpdateQuerySuggestionsBlockListRequestWithId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateQuerySuggestionsBlockListRequestWithName (const Aws::String &value)
 
UpdateQuerySuggestionsBlockListRequestWithName (Aws::String &&value)
 
UpdateQuerySuggestionsBlockListRequestWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateQuerySuggestionsBlockListRequestWithDescription (const Aws::String &value)
 
UpdateQuerySuggestionsBlockListRequestWithDescription (Aws::String &&value)
 
UpdateQuerySuggestionsBlockListRequestWithDescription (const char *value)
 
const S3PathGetSourceS3Path () const
 
bool SourceS3PathHasBeenSet () const
 
void SetSourceS3Path (const S3Path &value)
 
void SetSourceS3Path (S3Path &&value)
 
UpdateQuerySuggestionsBlockListRequestWithSourceS3Path (const S3Path &value)
 
UpdateQuerySuggestionsBlockListRequestWithSourceS3Path (S3Path &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
UpdateQuerySuggestionsBlockListRequestWithRoleArn (const Aws::String &value)
 
UpdateQuerySuggestionsBlockListRequestWithRoleArn (Aws::String &&value)
 
UpdateQuerySuggestionsBlockListRequestWithRoleArn (const char *value)
 
- Public Member Functions inherited from Aws::kendra::KendraRequest
virtual ~KendraRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file UpdateQuerySuggestionsBlockListRequest.h.

Constructor & Destructor Documentation

◆ UpdateQuerySuggestionsBlockListRequest()

Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::UpdateQuerySuggestionsBlockListRequest ( )

Member Function Documentation

◆ DescriptionHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::DescriptionHasBeenSet ( ) const
inline

The description for a block list.

Definition at line 169 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ GetDescription()

const Aws::String& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::GetDescription ( ) const
inline

The description for a block list.

Definition at line 164 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ GetId()

const Aws::String& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::GetId ( ) const
inline

The unique identifier of a block list.

Definition at line 82 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ GetIndexId()

const Aws::String& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::GetIndexId ( ) const
inline

The identifier of the index for a block list.

Definition at line 41 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ GetName()

const Aws::String& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::GetName ( ) const
inline

The name of a block list.

Definition at line 123 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

◆ GetRoleArn()

const Aws::String& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::GetRoleArn ( ) const
inline

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Definition at line 279 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetSourceS3Path()

const S3Path& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::GetSourceS3Path ( ) const
inline

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Definition at line 212 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ IdHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::IdHasBeenSet ( ) const
inline

The unique identifier of a block list.

Definition at line 87 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ IndexIdHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::IndexIdHasBeenSet ( ) const
inline

The identifier of the index for a block list.

Definition at line 46 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ NameHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::NameHasBeenSet ( ) const
inline

The name of a block list.

Definition at line 128 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::RoleArnHasBeenSet ( ) const
inline

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Definition at line 285 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SerializePayload()

Aws::String Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetDescription ( Aws::String &&  value)
inline

The description for a block list.

Definition at line 179 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetDescription() [2/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetDescription ( const Aws::String value)
inline

The description for a block list.

Definition at line 174 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetDescription() [3/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetDescription ( const char *  value)
inline

The description for a block list.

Definition at line 184 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetId() [1/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetId ( Aws::String &&  value)
inline

The unique identifier of a block list.

Definition at line 97 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetId() [2/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetId ( const Aws::String value)
inline

The unique identifier of a block list.

Definition at line 92 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetId() [3/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetId ( const char *  value)
inline

The unique identifier of a block list.

Definition at line 102 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetIndexId() [1/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetIndexId ( Aws::String &&  value)
inline

The identifier of the index for a block list.

Definition at line 56 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetIndexId() [2/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetIndexId ( const Aws::String value)
inline

The identifier of the index for a block list.

Definition at line 51 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetIndexId() [3/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetIndexId ( const char *  value)
inline

The identifier of the index for a block list.

Definition at line 61 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetName() [1/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetName ( Aws::String &&  value)
inline

The name of a block list.

Definition at line 138 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetName() [2/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetName ( const Aws::String value)
inline

The name of a block list.

Definition at line 133 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetName() [3/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetName ( const char *  value)
inline

The name of a block list.

Definition at line 143 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetRoleArn() [1/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetRoleArn ( Aws::String &&  value)
inline

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Definition at line 297 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetRoleArn() [2/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetRoleArn ( const Aws::String value)
inline

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Definition at line 291 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetRoleArn() [3/3]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetRoleArn ( const char *  value)
inline

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Definition at line 303 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetSourceS3Path() [1/2]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetSourceS3Path ( const S3Path value)
inline

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Definition at line 236 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SetSourceS3Path() [2/2]

void Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SetSourceS3Path ( S3Path &&  value)
inline

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Definition at line 248 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ SourceS3PathHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::SourceS3PathHasBeenSet ( ) const
inline

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Definition at line 224 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithDescription() [1/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithDescription ( Aws::String &&  value)
inline

The description for a block list.

Definition at line 194 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithDescription() [2/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithDescription ( const Aws::String value)
inline

The description for a block list.

Definition at line 189 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithDescription() [3/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithDescription ( const char *  value)
inline

The description for a block list.

Definition at line 199 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithId() [1/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithId ( Aws::String &&  value)
inline

The unique identifier of a block list.

Definition at line 112 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithId() [2/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithId ( const Aws::String value)
inline

The unique identifier of a block list.

Definition at line 107 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithId() [3/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithId ( const char *  value)
inline

The unique identifier of a block list.

Definition at line 117 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithIndexId() [1/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithIndexId ( Aws::String &&  value)
inline

The identifier of the index for a block list.

Definition at line 71 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithIndexId() [2/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithIndexId ( const Aws::String value)
inline

The identifier of the index for a block list.

Definition at line 66 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithIndexId() [3/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithIndexId ( const char *  value)
inline

The identifier of the index for a block list.

Definition at line 76 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithName() [1/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithName ( Aws::String &&  value)
inline

The name of a block list.

Definition at line 153 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithName() [2/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithName ( const Aws::String value)
inline

The name of a block list.

Definition at line 148 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithName() [3/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithName ( const char *  value)
inline

The name of a block list.

Definition at line 158 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithRoleArn() [1/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithRoleArn ( Aws::String &&  value)
inline

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Definition at line 315 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithRoleArn() [2/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithRoleArn ( const Aws::String value)
inline

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Definition at line 309 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithRoleArn() [3/3]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithRoleArn ( const char *  value)
inline

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Definition at line 321 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithSourceS3Path() [1/2]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithSourceS3Path ( const S3Path value)
inline

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Definition at line 260 of file UpdateQuerySuggestionsBlockListRequest.h.

◆ WithSourceS3Path() [2/2]

UpdateQuerySuggestionsBlockListRequest& Aws::kendra::Model::UpdateQuerySuggestionsBlockListRequest::WithSourceS3Path ( S3Path &&  value)
inline

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Definition at line 272 of file UpdateQuerySuggestionsBlockListRequest.h.


The documentation for this class was generated from the following file: