File tree Expand file tree Collapse file tree 3 files changed +10
-0
lines changed
olp-cpp-sdk-dataservice-read/include/olp/dataservice/read Expand file tree Collapse file tree 3 files changed +10
-0
lines changed Original file line number Diff line number Diff line change @@ -256,6 +256,8 @@ auto request = olp::dataservice::read::PartitionsRequest()
256256
257257Then pass it to the appropriate layer client, i.e. ` VersionedLayerClient ` via ` GetPartitions ` method:
258258
259+ > Note: If your layer has lots of partitions or uses TileKeys as partition IDs, then this operation can fail because of the large amount of data.
260+
259261``` cpp
260262// Create appropriate layer client with HRN, layer name and settings.
261263olp::dataservice::read::VersionedLayerClient layer_client (
Original file line number Diff line number Diff line change @@ -150,6 +150,8 @@ class DATASERVICE_READ_API VersionedLayerClient final {
150150 /* *
151151 * @brief Fetches a list of partitions for the given generic layer
152152 * asynchronously.
153+ * @note If your layer has lots of partitions or uses TileKeys as
154+ * partition IDs, then this operation can fail because of the large amount of data.
153155 * @param partitions_request Contains the complete set of the request
154156 * parameters.
155157 * @note GetLayerId value of the \c PartitionsRequest is ignored, and the
@@ -164,6 +166,8 @@ class DATASERVICE_READ_API VersionedLayerClient final {
164166 /* *
165167 * @brief Fetches a list of partitions for the given generic layer
166168 * asynchronously.
169+ * @note If your layer has lots of partitions or uses TileKeys as
170+ * partition IDs, then this operation can fail because of the large amount of data.
167171 * @param partitions_request Contains the complete set of the request
168172 * parameters.
169173 * @note GetLayerId value of the \c PartitionsRequest is ignored, and the
Original file line number Diff line number Diff line change @@ -98,6 +98,8 @@ class DATASERVICE_READ_API VolatileLayerClient final {
9898
9999 /* *
100100 * @brief Fetches a list partitions for given volatile layer asynchronously.
101+ * @note If your layer has lots of partitions or uses TileKeys as
102+ * partition IDs, then this operation can fail because of the large amount of data.
101103 * @param request contains the complete set of request parameters.
102104 * @param callback will be invoked once the list of partitions is available,
103105 * or an error is encountered.
@@ -108,6 +110,8 @@ class DATASERVICE_READ_API VolatileLayerClient final {
108110
109111 /* *
110112 * @brief Fetches a list partitions for given volatile layer asynchronously.
113+ * @note If your layer has lots of partitions or uses TileKeys as
114+ * partition IDs, then this operation can fail because of the large amount of data.
111115 * @param request contains the complete set of request parameters.
112116 * @return CancellableFuture, which when complete will contain the
113117 * PartitionsResponse or an error. Alternatively, the CancellableFuture can be
You can’t perform that action at this time.
0 commit comments