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

#include <DeletePrincipalMappingRequest.h>

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

Public Member Functions

 DeletePrincipalMappingRequest ()
 
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)
 
DeletePrincipalMappingRequestWithIndexId (const Aws::String &value)
 
DeletePrincipalMappingRequestWithIndexId (Aws::String &&value)
 
DeletePrincipalMappingRequestWithIndexId (const char *value)
 
const Aws::StringGetDataSourceId () const
 
bool DataSourceIdHasBeenSet () const
 
void SetDataSourceId (const Aws::String &value)
 
void SetDataSourceId (Aws::String &&value)
 
void SetDataSourceId (const char *value)
 
DeletePrincipalMappingRequestWithDataSourceId (const Aws::String &value)
 
DeletePrincipalMappingRequestWithDataSourceId (Aws::String &&value)
 
DeletePrincipalMappingRequestWithDataSourceId (const char *value)
 
const Aws::StringGetGroupId () const
 
bool GroupIdHasBeenSet () const
 
void SetGroupId (const Aws::String &value)
 
void SetGroupId (Aws::String &&value)
 
void SetGroupId (const char *value)
 
DeletePrincipalMappingRequestWithGroupId (const Aws::String &value)
 
DeletePrincipalMappingRequestWithGroupId (Aws::String &&value)
 
DeletePrincipalMappingRequestWithGroupId (const char *value)
 
long long GetOrderingId () const
 
bool OrderingIdHasBeenSet () const
 
void SetOrderingId (long long value)
 
DeletePrincipalMappingRequestWithOrderingId (long long 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 21 of file DeletePrincipalMappingRequest.h.

Constructor & Destructor Documentation

◆ DeletePrincipalMappingRequest()

Aws::kendra::Model::DeletePrincipalMappingRequest::DeletePrincipalMappingRequest ( )

Member Function Documentation

◆ DataSourceIdHasBeenSet()

bool Aws::kendra::Model::DeletePrincipalMappingRequest::DataSourceIdHasBeenSet ( ) const
inline

The identifier of the data source you want to delete a group from.

This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Definition at line 100 of file DeletePrincipalMappingRequest.h.

◆ GetDataSourceId()

const Aws::String& Aws::kendra::Model::DeletePrincipalMappingRequest::GetDataSourceId ( ) const
inline

The identifier of the data source you want to delete a group from.

This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Definition at line 88 of file DeletePrincipalMappingRequest.h.

◆ GetGroupId()

const Aws::String& Aws::kendra::Model::DeletePrincipalMappingRequest::GetGroupId ( ) const
inline

The identifier of the group you want to delete.

Definition at line 178 of file DeletePrincipalMappingRequest.h.

◆ GetIndexId()

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

The identifier of the index you want to delete a group from.

Definition at line 40 of file DeletePrincipalMappingRequest.h.

◆ GetOrderingId()

long long Aws::kendra::Model::DeletePrincipalMappingRequest::GetOrderingId ( ) const
inline

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the UNIX time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your DELETE action for that updated group with the latest members list doesn't get overwritten by earlier DELETE actions for the same group which are yet to be processed.

The default ordering ID is the current UNIX time in milliseconds that the action was received by Amazon Kendra.

Definition at line 230 of file DeletePrincipalMappingRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::kendra::KendraRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DeletePrincipalMappingRequest.h.

◆ GroupIdHasBeenSet()

bool Aws::kendra::Model::DeletePrincipalMappingRequest::GroupIdHasBeenSet ( ) const
inline

The identifier of the group you want to delete.

Definition at line 183 of file DeletePrincipalMappingRequest.h.

◆ IndexIdHasBeenSet()

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

The identifier of the index you want to delete a group from.

Definition at line 45 of file DeletePrincipalMappingRequest.h.

◆ OrderingIdHasBeenSet()

bool Aws::kendra::Model::DeletePrincipalMappingRequest::OrderingIdHasBeenSet ( ) const
inline

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the UNIX time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your DELETE action for that updated group with the latest members list doesn't get overwritten by earlier DELETE actions for the same group which are yet to be processed.

The default ordering ID is the current UNIX time in milliseconds that the action was received by Amazon Kendra.

Definition at line 246 of file DeletePrincipalMappingRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDataSourceId() [1/3]

void Aws::kendra::Model::DeletePrincipalMappingRequest::SetDataSourceId ( Aws::String &&  value)
inline

The identifier of the data source you want to delete a group from.

This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Definition at line 124 of file DeletePrincipalMappingRequest.h.

◆ SetDataSourceId() [2/3]

void Aws::kendra::Model::DeletePrincipalMappingRequest::SetDataSourceId ( const Aws::String value)
inline

The identifier of the data source you want to delete a group from.

This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Definition at line 112 of file DeletePrincipalMappingRequest.h.

◆ SetDataSourceId() [3/3]

void Aws::kendra::Model::DeletePrincipalMappingRequest::SetDataSourceId ( const char *  value)
inline

The identifier of the data source you want to delete a group from.

This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Definition at line 136 of file DeletePrincipalMappingRequest.h.

◆ SetGroupId() [1/3]

void Aws::kendra::Model::DeletePrincipalMappingRequest::SetGroupId ( Aws::String &&  value)
inline

The identifier of the group you want to delete.

Definition at line 193 of file DeletePrincipalMappingRequest.h.

◆ SetGroupId() [2/3]

void Aws::kendra::Model::DeletePrincipalMappingRequest::SetGroupId ( const Aws::String value)
inline

The identifier of the group you want to delete.

Definition at line 188 of file DeletePrincipalMappingRequest.h.

◆ SetGroupId() [3/3]

void Aws::kendra::Model::DeletePrincipalMappingRequest::SetGroupId ( const char *  value)
inline

The identifier of the group you want to delete.

Definition at line 198 of file DeletePrincipalMappingRequest.h.

◆ SetIndexId() [1/3]

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

The identifier of the index you want to delete a group from.

Definition at line 55 of file DeletePrincipalMappingRequest.h.

◆ SetIndexId() [2/3]

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

The identifier of the index you want to delete a group from.

Definition at line 50 of file DeletePrincipalMappingRequest.h.

◆ SetIndexId() [3/3]

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

The identifier of the index you want to delete a group from.

Definition at line 60 of file DeletePrincipalMappingRequest.h.

◆ SetOrderingId()

void Aws::kendra::Model::DeletePrincipalMappingRequest::SetOrderingId ( long long  value)
inline

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the UNIX time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your DELETE action for that updated group with the latest members list doesn't get overwritten by earlier DELETE actions for the same group which are yet to be processed.

The default ordering ID is the current UNIX time in milliseconds that the action was received by Amazon Kendra.

Definition at line 262 of file DeletePrincipalMappingRequest.h.

◆ WithDataSourceId() [1/3]

DeletePrincipalMappingRequest& Aws::kendra::Model::DeletePrincipalMappingRequest::WithDataSourceId ( Aws::String &&  value)
inline

The identifier of the data source you want to delete a group from.

This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Definition at line 160 of file DeletePrincipalMappingRequest.h.

◆ WithDataSourceId() [2/3]

DeletePrincipalMappingRequest& Aws::kendra::Model::DeletePrincipalMappingRequest::WithDataSourceId ( const Aws::String value)
inline

The identifier of the data source you want to delete a group from.

This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Definition at line 148 of file DeletePrincipalMappingRequest.h.

◆ WithDataSourceId() [3/3]

DeletePrincipalMappingRequest& Aws::kendra::Model::DeletePrincipalMappingRequest::WithDataSourceId ( const char *  value)
inline

The identifier of the data source you want to delete a group from.

This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Definition at line 172 of file DeletePrincipalMappingRequest.h.

◆ WithGroupId() [1/3]

DeletePrincipalMappingRequest& Aws::kendra::Model::DeletePrincipalMappingRequest::WithGroupId ( Aws::String &&  value)
inline

The identifier of the group you want to delete.

Definition at line 208 of file DeletePrincipalMappingRequest.h.

◆ WithGroupId() [2/3]

DeletePrincipalMappingRequest& Aws::kendra::Model::DeletePrincipalMappingRequest::WithGroupId ( const Aws::String value)
inline

The identifier of the group you want to delete.

Definition at line 203 of file DeletePrincipalMappingRequest.h.

◆ WithGroupId() [3/3]

DeletePrincipalMappingRequest& Aws::kendra::Model::DeletePrincipalMappingRequest::WithGroupId ( const char *  value)
inline

The identifier of the group you want to delete.

Definition at line 213 of file DeletePrincipalMappingRequest.h.

◆ WithIndexId() [1/3]

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

The identifier of the index you want to delete a group from.

Definition at line 70 of file DeletePrincipalMappingRequest.h.

◆ WithIndexId() [2/3]

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

The identifier of the index you want to delete a group from.

Definition at line 65 of file DeletePrincipalMappingRequest.h.

◆ WithIndexId() [3/3]

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

The identifier of the index you want to delete a group from.

Definition at line 75 of file DeletePrincipalMappingRequest.h.

◆ WithOrderingId()

DeletePrincipalMappingRequest& Aws::kendra::Model::DeletePrincipalMappingRequest::WithOrderingId ( long long  value)
inline

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the UNIX time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your DELETE action for that updated group with the latest members list doesn't get overwritten by earlier DELETE actions for the same group which are yet to be processed.

The default ordering ID is the current UNIX time in milliseconds that the action was received by Amazon Kendra.

Definition at line 278 of file DeletePrincipalMappingRequest.h.


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