olp::dataservice::write::IndexLayerClient Class Reference

Publishes data to an index layer. More...

#include <IndexLayerClient.h>

Public Member Functions
	IndexLayerClient (client::HRN catalog, client::OlpClientSettings settings)
	Creates the IndexLayerClient instance. More...
void	CancelPendingRequests ()
	Cancels all the ongoing operations that this client started. More...
olp::client::CancellableFuture< PublishIndexResponse >	PublishIndex (model::PublishIndexRequest request)
	Publishes the index to the index layer. More...
olp::client::CancellationToken	PublishIndex (model::PublishIndexRequest request, PublishIndexCallback callback)
	Publishes the index to the index layer. More...
olp::client::CancellationToken	DeleteIndexData (model::DeleteIndexDataRequest request, DeleteIndexDataCallback callback)
	Deletes the data blob that is stored under the index layer. More...
olp::client::CancellableFuture< DeleteIndexDataResponse >	DeleteIndexData (model::DeleteIndexDataRequest request)
	Deletes the data blob that is stored under the index layer. More...
olp::client::CancellableFuture< UpdateIndexResponse >	UpdateIndex (model::UpdateIndexRequest request)
	Updates index information in the index layer. More...
olp::client::CancellationToken	UpdateIndex (model::UpdateIndexRequest request, UpdateIndexCallback callback)
	Updates index information in the index layer. More...

Detailed Description

Publishes data to an index layer.

Constructor & Destructor Documentation

IndexLayerClient()

olp::dataservice::write::IndexLayerClient::IndexLayerClient	(	client::HRN	catalog,
		client::OlpClientSettings	settings
	)

Creates the IndexLayerClient instance.

Parameters

catalog	The HRN of the catalog to which this client writes.
settings	The client settings used to control the behavior of the client instance.

Member Function Documentation

CancelPendingRequests()

void olp::dataservice::write::IndexLayerClient::CancelPendingRequests

(

)

Cancels all the ongoing operations that this client started.

It returns instantly and does not wait for callbacks. Use this operation to cancel all the pending requests without destroying the actual client instance.

DeleteIndexData() [1/2]

olp::client::CancellableFuture<DeleteIndexDataResponse> olp::dataservice::write::IndexLayerClient::DeleteIndexData

(

model::DeleteIndexDataRequest

request

)

Deletes the data blob that is stored under the index layer.

Parameters

request

The DeleteIndexDataRequest object.

Returns

CancellableFuture that contains DeleteIndexDataResponse.

DeleteIndexData() [2/2]

olp::client::CancellationToken olp::dataservice::write::IndexLayerClient::DeleteIndexData	(	model::DeleteIndexDataRequest	request,
		DeleteIndexDataCallback	callback
	)

Deletes the data blob that is stored under the index layer.

Parameters

request	The DeleteIndexDataRequest object.
callback	DeleteIndexDataCallback that is called with DeleteIndexDataResponse when the operation completes.

Returns

CancellationToken that can be used to cancel the ongoing request.

PublishIndex() [1/2]

olp::client::CancellableFuture<PublishIndexResponse> olp::dataservice::write::IndexLayerClient::PublishIndex

(

model::PublishIndexRequest

request

)

Publishes the index to the index layer.

Note

The content-type for this request is set implicitly based on the layer metadata of the target layer.

Parameters

request

The PublishIndexRequest object.

Returns

CancellableFuture that contains PublishIndexResponse.

PublishIndex() [2/2]

olp::client::CancellationToken olp::dataservice::write::IndexLayerClient::PublishIndex	(	model::PublishIndexRequest	request,
		PublishIndexCallback	callback
	)

Publishes the index to the index layer.

Note

The content-type for this request is set implicitly based on the layer metadata of the target layer.

Parameters

request	The PublishIndexRequest object.
callback	PublishIndexCallback that is called with PublishIndexResponse when the operation completes.

Returns

CancellationToken that can be used to cancel the ongoing request.

UpdateIndex() [1/2]

olp::client::CancellableFuture<UpdateIndexResponse> olp::dataservice::write::IndexLayerClient::UpdateIndex

(

model::UpdateIndexRequest

request

)

Updates index information in the index layer.

Parameters

request

The UpdateIndexRequest object.

Returns

CancellableFuture that contains PublishIndexResponse.

UpdateIndex() [2/2]

olp::client::CancellationToken olp::dataservice::write::IndexLayerClient::UpdateIndex	(	model::UpdateIndexRequest	request,
		UpdateIndexCallback	callback
	)

Updates index information in the index layer.

Parameters

request	The UpdateIndexRequest object.
callback	PublishIndexCallback that is called with PublishIndexResponse when the operation completes.

Returns

CancellationToken that can be used to cancel the ongoing request.

---

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

• olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/IndexLayerClient.h