olp::dataservice::write::model::DeleteIndexDataRequest Class Reference

Deletes index data from an index layer. More...

#include <DeleteIndexDataRequest.h>

Public Member Functions
	DeleteIndexDataRequest ()=default
	A default constructor.
	DeleteIndexDataRequest (const DeleteIndexDataRequest &)=default
	DeleteIndexDataRequest (DeleteIndexDataRequest &&)=default
DeleteIndexDataRequest &	operator= (const DeleteIndexDataRequest &)=default
DeleteIndexDataRequest &	operator= (DeleteIndexDataRequest &&)=default
const std::string &	GetLayerId () const
	Gets the layer ID to which the data blob belongs. More...
DeleteIndexDataRequest &	WithLayerId (const std::string &layer_id)
	Sets the layer ID to which the data blob belongs. More...
DeleteIndexDataRequest &	WithLayerId (std::string &&layer_id)
	Sets the layer ID to which the data blob belongs. More...
const std::string &	GetIndexId () const
	Gets the index ID that is associated with the data blob. More...
DeleteIndexDataRequest &	WithIndexId (const std::string &index_id)
	Sets the index ID that is associated with the data blob. More...
DeleteIndexDataRequest &	WithIndexId (const std::string &&index_id)
	Sets the index ID that is associated with the data blob. More...

Detailed Description

Deletes index data from an index layer.

Member Function Documentation

GetIndexId()

const std::string& olp::dataservice::write::model::DeleteIndexDataRequest::GetIndexId ( ) const

inline

Gets the index ID that is associated with the data blob.

Returns

The index ID.

GetLayerId()

const std::string& olp::dataservice::write::model::DeleteIndexDataRequest::GetLayerId ( ) const

inline

Gets the layer ID to which the data blob belongs.

Returns

The layer ID.

WithIndexId() [1/2]

DeleteIndexDataRequest& olp::dataservice::write::model::DeleteIndexDataRequest::WithIndexId ( const std::string &&  index_id )

inline

Sets the index ID that is associated with the data blob.

Include it in the callback of IndexLayerClient::PublishIndex() if the operation is successful.

Parameters

index_id

The rvalue reference to the index ID.

WithIndexId() [2/2]

DeleteIndexDataRequest& olp::dataservice::write::model::DeleteIndexDataRequest::WithIndexId ( const std::string &  index_id )

inline

Sets the index ID that is associated with the data blob.

Include it in the callback of IndexLayerClient::PublishIndex() if the operation is successful.

Parameters

index_id

The index ID.

WithLayerId() [1/2]

DeleteIndexDataRequest& olp::dataservice::write::model::DeleteIndexDataRequest::WithLayerId ( const std::string &  layer_id )

inline

Sets the layer ID to which the data blob belongs.

Make sure the layer is of the index type.

Parameters

layer_id

The layer ID.

WithLayerId() [2/2]

DeleteIndexDataRequest& olp::dataservice::write::model::DeleteIndexDataRequest::WithLayerId ( std::string &&  layer_id )

inline

Sets the layer ID to which the data blob belongs.

Make sure the layer is of the index type.

Parameters

layer_id

The rvalue reference to the layer ID.

---

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

• olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/DeleteIndexDataRequest.h