olp::dataservice::write::VersionedLayerClient Class Reference

Publishes data to a versioned layers. More...

#include <VersionedLayerClient.h>

Public Member Functions
	VersionedLayerClient (client::HRN catalog, client::OlpClientSettings settings)
	Creates the VersionedLayerClient instance. More...
olp::client::CancellableFuture< StartBatchResponse >	StartBatch (model::StartBatchRequest request)
	Starts the batch operation. More...
olp::client::CancellationToken	StartBatch (model::StartBatchRequest request, StartBatchCallback callback)
	Starts the batch operation. More...
olp::client::CancellableFuture< GetBaseVersionResponse >	GetBaseVersion ()
	Gets the latest version number of the catalog. More...
olp::client::CancellationToken	GetBaseVersion (GetBaseVersionCallback callback)
	Gets the latest version number of the catalog. More...
olp::client::CancellableFuture< GetBatchResponse >	GetBatch (const model::Publication &pub)
	Gets the details of the batch publication. More...
olp::client::CancellationToken	GetBatch (const model::Publication &pub, GetBatchCallback callback)
	Gets the details of the batch publication. More...
olp::client::CancellableFuture< CompleteBatchResponse >	CompleteBatch (const model::Publication &pub)
	Completes the batch operation and commits it to the HERE platform. More...
olp::client::CancellationToken	CompleteBatch (const model::Publication &pub, CompleteBatchCallback callback)
	Completes the batch operation and commits it to the HERE platform. More...
olp::client::CancellableFuture< CancelBatchResponse >	CancelBatch (const model::Publication &pub)
	Cancels the batch operation. More...
olp::client::CancellationToken	CancelBatch (const model::Publication &pub, CancelBatchCallback callback)
	Cancels the batch operation. More...
void	CancelPendingRequests ()
	Cancels all the ongoing operations that this client started. More...
olp::client::CancellableFuture< PublishPartitionDataResponse >	PublishToBatch (const model::Publication &pub, model::PublishPartitionDataRequest request)
	Publishes data to the versioned layer. More...
olp::client::CancellationToken	PublishToBatch (const model::Publication &pub, model::PublishPartitionDataRequest request, PublishPartitionDataCallback callback)
	Publishes data to the versioned layer. More...
olp::client::CancellableFuture< CheckDataExistsResponse >	CheckDataExists (model::CheckDataExistsRequest request)
	Checks whether the data handle exits. More...
olp::client::CancellationToken	CheckDataExists (model::CheckDataExistsRequest request, CheckDataExistsCallback callback)
	Checks whether the data handle exits. More...

Detailed Description

Publishes data to a versioned layers.

Constructor & Destructor Documentation

VersionedLayerClient()

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

Creates the VersionedLayerClient 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

CancelBatch() [1/2]

olp::client::CancellableFuture<CancelBatchResponse> olp::dataservice::write::VersionedLayerClient::CancelBatch

(

const model::Publication &

pub

)

Cancels the batch operation.

Parameters

pub	The Publication instance.

Returns

CancellableFuturethat containsCancelBatchResponse`.

CancelBatch() [2/2]

olp::client::CancellationToken olp::dataservice::write::VersionedLayerClient::CancelBatch	(	const model::Publication &	pub,
		CancelBatchCallback	callback
	)

Cancels the batch operation.

Parameters

pub	The Publication instance.
callback	CancelBatchCallback that is called with CancelBatchResponse when the operation is cancelled.

Returns

CancellationToken that can be used to cancel the ongoing request.

CancelPendingRequests()

void olp::dataservice::write::VersionedLayerClient::CancelPendingRequests

(

)

Cancels all the ongoing operations that this client started.

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

CheckDataExists() [1/2]

olp::client::CancellableFuture<CheckDataExistsResponse> olp::dataservice::write::VersionedLayerClient::CheckDataExists

(

model::CheckDataExistsRequest

request

)

Checks whether the data handle exits.

Parameters

request

The CheckDataExistsRequest object.

Returns

CancellableFuture that contains CheckDataExistsResponse.

CheckDataExists() [2/2]

olp::client::CancellationToken olp::dataservice::write::VersionedLayerClient::CheckDataExists	(	model::CheckDataExistsRequest	request,
		CheckDataExistsCallback	callback
	)

Checks whether the data handle exits.

Parameters

request	The CheckDataExistsRequest object.
callback	CheckDataExistsCallback that is called with CheckDataExistsResponse when the operation completes.

Returns

CancellationToken that can be used to cancel the ongoing request.

CompleteBatch() [1/2]

olp::client::CancellableFuture<CompleteBatchResponse> olp::dataservice::write::VersionedLayerClient::CompleteBatch

(

const model::Publication &

pub

)

Completes the batch operation and commits it to the HERE platform.

Parameters

pub	The Publication instance.

Returns

CancellableFuture that contains CompleteBatchResponse.

CompleteBatch() [2/2]

olp::client::CancellationToken olp::dataservice::write::VersionedLayerClient::CompleteBatch	(	const model::Publication &	pub,
		CompleteBatchCallback	callback
	)

Completes the batch operation and commits it to the HERE platform.

Parameters

pub	The Publication instance.
callback	CompleteBatchCallback that is called with CompleteBatchResponse when the operation completes.

Returns

CancellationToken that can be used to cancel the ongoing request.

GetBaseVersion() [1/2]

olp::client::CancellableFuture<GetBaseVersionResponse> olp::dataservice::write::VersionedLayerClient::GetBaseVersion

(

)

Gets the latest version number of the catalog.

Returns

CancellableFuture that contains the latest version number of the catalog.

GetBaseVersion() [2/2]

olp::client::CancellationToken olp::dataservice::write::VersionedLayerClient::GetBaseVersion

(

GetBaseVersionCallback

callback

)

Gets the latest version number of the catalog.

Parameters

callback

GetBaseVersionCallback that is called with GetBaseVersionResponse when the operation completes.

Returns

CancellationToken that can be used to cancel the ongoing request.

GetBatch() [1/2]

olp::client::CancellableFuture<GetBatchResponse> olp::dataservice::write::VersionedLayerClient::GetBatch

(

const model::Publication &

pub

)

Gets the details of the batch publication.

Parameters

pub	The Publication instance.

Returns

CancellableFuture that contains the details of the batch publication.

GetBatch() [2/2]

olp::client::CancellationToken olp::dataservice::write::VersionedLayerClient::GetBatch	(	const model::Publication &	pub,
		GetBatchCallback	callback
	)

Gets the details of the batch publication.

Parameters

pub	The Publication instance.
callback	GetBatchCallback that is called with GetBatchResponse when the operation completes.

Returns

CancellationToken that can be used to cancel the ongoing request.

PublishToBatch() [1/2]

olp::client::CancellableFuture<PublishPartitionDataResponse> olp::dataservice::write::VersionedLayerClient::PublishToBatch	(	const model::Publication &	pub,
		model::PublishPartitionDataRequest	request
	)

Publishes data to the versioned layer.

Note

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

Parameters

pub	The Publication instance.
request	The PublishPartitionDataRequest object.

Returns

CancellableFuture that contains PublishPartitionDataResponse.

PublishToBatch() [2/2]

olp::client::CancellationToken olp::dataservice::write::VersionedLayerClient::PublishToBatch	(	const model::Publication &	pub,
		model::PublishPartitionDataRequest	request,
		PublishPartitionDataCallback	callback
	)

Publishes data to the versioned layer.

Note

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

Parameters

pub	The Publication instance.
request	The PublishPartitionDataRequest object.
callback	PublishPartitionDataCallback that is called with PublishPartitionDataResponse when the operation completes.

Returns

CancellationToken that can be used to cancel the ongoing request.

StartBatch() [1/2]

olp::client::CancellableFuture<StartBatchResponse> olp::dataservice::write::VersionedLayerClient::StartBatch

(

model::StartBatchRequest

request

)

Starts the batch operation.

Parameters

request

The StartBatchRequest object.

Returns

CancellableFuture that contains StartBatchResponse.

StartBatch() [2/2]

olp::client::CancellationToken olp::dataservice::write::VersionedLayerClient::StartBatch	(	model::StartBatchRequest	request,
		StartBatchCallback	callback
	)

Starts the batch operation.

Parameters

request	The StartBatchRequest object.
callback	StartBatchCallback that is called with StartBatchResponse 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/VersionedLayerClient.h