|
1 | 1 | <!DOCTYPE HTML>
|
2 | 2 | <html lang="en">
|
3 | 3 | <head>
|
4 |
| -<!-- Generated by javadoc (21) on Thu Apr 04 19:38:40 CEST 2024 --> |
5 |
| -<title>DataAPIOptions.DataAPIClientOptionsBuilder (Java Client Library for Data API 1.0.0-beta1 API)</title> |
| 4 | +<!-- Generated by javadoc (21) on Thu Apr 18 23:32:44 CEST 2024 --> |
| 5 | +<title>DataAPIOptions.DataAPIClientOptionsBuilder (Java Client Library for Data API 1.0.1 API)</title> |
6 | 6 | <meta name="viewport" content="width=device-width, initial-scale=1">
|
7 | 7 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
8 |
| -<meta name="dc.created" content="2024-04-04"> |
| 8 | +<meta name="dc.created" content="2024-04-18"> |
9 | 9 | <meta name="description" content="declaration: package: com.datastax.astra.client, class: DataAPIOptions, class: DataAPIClientOptionsBuilder">
|
10 | 10 | <meta name="generator" content="javadoc/ClassWriterImpl">
|
11 | 11 | <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
@@ -183,6 +183,21 @@ <h2>Method Summary</h2>
|
183 | 183 | <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
184 | 184 | <div class="block">Sets the delay between retry attempts when the number of retries is greater than 1.</div>
|
185 | 185 | </div>
|
| 186 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DataAPIOptions.DataAPIClientOptionsBuilder.html" title="class in com.datastax.astra.client">DataAPIOptions.DataAPIClientOptionsBuilder</a></code></div> |
| 187 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withMaxDocumentCount(int)" class="member-name-link">withMaxDocumentCount</a><wbr>(int maxDocumentCount)</code></div> |
| 188 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| 189 | +<div class="block">Sets the maximum number of documents that can be returned by the count function.</div> |
| 190 | +</div> |
| 191 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DataAPIOptions.DataAPIClientOptionsBuilder.html" title="class in com.datastax.astra.client">DataAPIOptions.DataAPIClientOptionsBuilder</a></code></div> |
| 192 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withMaxDocumentsInInsert(int)" class="member-name-link">withMaxDocumentsInInsert</a><wbr>(int maxDocumentsInInsert)</code></div> |
| 193 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| 194 | +<div class="block">Sets the maximum number of documents that can be inserted in a single operation.</div> |
| 195 | +</div> |
| 196 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DataAPIOptions.DataAPIClientOptionsBuilder.html" title="class in com.datastax.astra.client">DataAPIOptions.DataAPIClientOptionsBuilder</a></code></div> |
| 197 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withMaxPageSize(int)" class="member-name-link">withMaxPageSize</a><wbr>(int maxPageSize)</code></div> |
| 198 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| 199 | +<div class="block">Sets the maximum number of documents that can be returned in a single page.</div> |
| 200 | +</div> |
186 | 201 | </div>
|
187 | 202 | </div>
|
188 | 203 | </div>
|
@@ -368,6 +383,84 @@ <h3>withHttpRetryDelayMillis</h3>
|
368 | 383 | </section>
|
369 | 384 | </li>
|
370 | 385 | <li>
|
| 386 | +<section class="detail" id="withMaxDocumentCount(int)"> |
| 387 | +<h3>withMaxDocumentCount</h3> |
| 388 | +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DataAPIOptions.DataAPIClientOptionsBuilder.html" title="class in com.datastax.astra.client">DataAPIOptions.DataAPIClientOptionsBuilder</a></span> <span class="element-name">withMaxDocumentCount</span><wbr><span class="parameters">(int maxDocumentCount)</span></div> |
| 389 | +<div class="block">Sets the maximum number of documents that can be returned by the count function. |
| 390 | + <p> |
| 391 | + If not explicitly set, the default value is defined by <code>MAX_DOCUMENTS_COUNT</code>, |
| 392 | + which is 1000 documents. |
| 393 | + </p></div> |
| 394 | +<dl class="notes"> |
| 395 | +<dt>Parameters:</dt> |
| 396 | +<dd><code>maxDocumentCount</code> - the maximum number of documents that can be returned by the count function. |
| 397 | + Must be a positive number.</dd> |
| 398 | +<dt>Returns:</dt> |
| 399 | +<dd>a reference to this builder, allowing for method chaining. |
| 400 | + |
| 401 | + Example usage: |
| 402 | + <pre> |
| 403 | + <code> |
| 404 | + DataAPIClientOptions |
| 405 | + .builder() |
| 406 | + .withMaxDocumentCount(2000); // Sets the maximum number of documents to 2000. |
| 407 | + </code></pre></dd> |
| 408 | +</dl> |
| 409 | +</section> |
| 410 | +</li> |
| 411 | +<li> |
| 412 | +<section class="detail" id="withMaxPageSize(int)"> |
| 413 | +<h3>withMaxPageSize</h3> |
| 414 | +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DataAPIOptions.DataAPIClientOptionsBuilder.html" title="class in com.datastax.astra.client">DataAPIOptions.DataAPIClientOptionsBuilder</a></span> <span class="element-name">withMaxPageSize</span><wbr><span class="parameters">(int maxPageSize)</span></div> |
| 415 | +<div class="block">Sets the maximum number of documents that can be returned in a single page. |
| 416 | + <p> |
| 417 | + If not explicitly set, the default value is defined by <code>MAX_PAGE_SIZE</code>, |
| 418 | + which is 20 documents. |
| 419 | + </p></div> |
| 420 | +<dl class="notes"> |
| 421 | +<dt>Parameters:</dt> |
| 422 | +<dd><code>maxPageSize</code> - the maximum number of documents that can be returned in a single page. |
| 423 | + Must be a positive number.</dd> |
| 424 | +<dt>Returns:</dt> |
| 425 | +<dd>a reference to this builder, allowing for method chaining. |
| 426 | + |
| 427 | + Example usage: |
| 428 | + <pre> |
| 429 | + <code> |
| 430 | + DataAPIClientOptions |
| 431 | + .builder() |
| 432 | + .withMaxPageSize(50); // Sets the maximum page size to 50 documents. |
| 433 | + </code></pre></dd> |
| 434 | +</dl> |
| 435 | +</section> |
| 436 | +</li> |
| 437 | +<li> |
| 438 | +<section class="detail" id="withMaxDocumentsInInsert(int)"> |
| 439 | +<h3>withMaxDocumentsInInsert</h3> |
| 440 | +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DataAPIOptions.DataAPIClientOptionsBuilder.html" title="class in com.datastax.astra.client">DataAPIOptions.DataAPIClientOptionsBuilder</a></span> <span class="element-name">withMaxDocumentsInInsert</span><wbr><span class="parameters">(int maxDocumentsInInsert)</span></div> |
| 441 | +<div class="block">Sets the maximum number of documents that can be inserted in a single operation. |
| 442 | + <p> |
| 443 | + If not explicitly set, the default value is defined by <code>MAX_DOCUMENTS_IN_INSERT</code>, |
| 444 | + which is 20 documents. |
| 445 | + </p></div> |
| 446 | +<dl class="notes"> |
| 447 | +<dt>Parameters:</dt> |
| 448 | +<dd><code>maxDocumentsInInsert</code> - the maximum number of documents that can be inserted in a single operation. |
| 449 | + Must be a positive number.</dd> |
| 450 | +<dt>Returns:</dt> |
| 451 | +<dd>a reference to this builder, allowing for method chaining. |
| 452 | + |
| 453 | + Example usage: |
| 454 | + <pre> |
| 455 | + <code> |
| 456 | + DataAPIClientOptions |
| 457 | + .builder() |
| 458 | + .withMaxDocumentsInInsert(50); // Sets the maximum number of documents to insert to 50. |
| 459 | + </code></pre></dd> |
| 460 | +</dl> |
| 461 | +</section> |
| 462 | +</li> |
| 463 | +<li> |
371 | 464 | <section class="detail" id="build()">
|
372 | 465 | <h3>build</h3>
|
373 | 466 | <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DataAPIOptions.html" title="class in com.datastax.astra.client">DataAPIOptions</a></span> <span class="element-name">build</span>()</div>
|
|
0 commit comments