Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace Integer Options with Defaulted int #17385

Merged
merged 4 commits into from
Nov 10, 2020
Merged

Replace Integer Options with Defaulted int #17385

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d0d7c4e
Replace Integer options with defaulted int
alzimmermsft Nov 9, 2020
c53c9ad
Merge branch 'master' into AzSearch_ChangeIntegerIntoInt
alzimmermsft Nov 9, 2020
6f141fe
Update Duration APIs to require non-null, changed Boolean to boolean
alzimmermsft Nov 10, 2020
be7494b
Cleanup documentation
alzimmermsft Nov 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions ...cuments/src/main/java/com/azure/search/documents/SearchIndexingBufferedSenderOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ public final class SearchIndexingBufferedSenderOptions<T> {

private Boolean autoFlush;
private Duration autoFlushWindow;
private Integer initialBatchActionCount;
private Integer maxRetries;
private int initialBatchActionCount = DEFAULT_INITIAL_BATCH_ACTION_COUNT;
private int maxRetries = DEFAULT_MAX_RETRIES;
private Duration retryDelay;
private Duration maxRetryDelay;

Expand All @@ -45,7 +45,7 @@ public final class SearchIndexingBufferedSenderOptions<T> {

/**
* Sets the flag determining whether a buffered sender will automatically flush its document batch based on the
* configurations of {@link #setAutoFlushWindow(Duration)} and {@link #setInitialBatchActionCount(Integer)}.
* configurations of {@link #setAutoFlushWindow(Duration)} and {@link #setInitialBatchActionCount(int)}.
* <p>
* If {@code autoFlush} is null the buffered sender will be set to automatically flush.
*
Expand All @@ -70,11 +70,11 @@ public boolean getAutoFlush() {
* Sets the duration between a buffered sender sending documents to be indexed.
* <p>
* The buffered sender will reset the duration when documents are sent for indexing, either by reaching {@link
* #setInitialBatchActionCount(Integer)} or by a manual trigger.
* #setInitialBatchActionCount(int)} or by a manual trigger.
* <p>
* If {@code flushWindow} is negative or zero and {@link #setAutoFlush(Boolean)} is enabled the buffered sender will
* only flush when {@link #setInitialBatchActionCount(Integer)} is met. If {@code flushWindow} is null a default
* value of 60 seconds is used.
* only flush when {@link #setInitialBatchActionCount(int)} is met. If {@code flushWindow} is null a default value
* of 60 seconds is used.
*
* @param autoFlushWindow Duration between document batches being sent for indexing.
* @return The updated SearchIndexingBufferedSenderOptions object.
Expand All @@ -88,7 +88,7 @@ public SearchIndexingBufferedSenderOptions<T> setAutoFlushWindow(Duration autoFl
* Gets the {@link Duration} that the buffered sender will wait between sending documents to be indexed.
* <p>
* The buffered sender will reset the duration when documents are sent for indexing, either by reaching {@link
* #setInitialBatchActionCount(Integer)} or by a manual trigger.
* #setInitialBatchActionCount(int)} or by a manual trigger.
* <p>
* If the duration is less than or equal to zero the buffered sender will only flush when {@link
* #getInitialBatchActionCount()} is triggered.
Expand All @@ -112,10 +112,11 @@ public Duration getAutoFlushWindow() {
* @return The updated SearchIndexingBufferedSenderOptions object.
* @throws IllegalArgumentException If {@code batchSize} is less than one.
*/
public SearchIndexingBufferedSenderOptions<T> setInitialBatchActionCount(Integer initialBatchActionCount) {
if (initialBatchActionCount != null && initialBatchActionCount < 1) {
public SearchIndexingBufferedSenderOptions<T> setInitialBatchActionCount(int initialBatchActionCount) {
if (initialBatchActionCount < 1) {
throw logger.logExceptionAsError(new IllegalArgumentException("'batchSize' cannot be less than one."));
}

this.initialBatchActionCount = initialBatchActionCount;
return this;
}
Expand All @@ -128,7 +129,7 @@ public SearchIndexingBufferedSenderOptions<T> setInitialBatchActionCount(Integer
* @return The number of documents required before a flush is triggered.
*/
public int getInitialBatchActionCount() {
return (initialBatchActionCount == null) ? DEFAULT_INITIAL_BATCH_ACTION_COUNT : initialBatchActionCount;
return initialBatchActionCount;
}

/**
Expand All @@ -142,8 +143,8 @@ public int getInitialBatchActionCount() {
* @return The updated SearchIndexingBufferedSenderOptions object.
* @throws IllegalArgumentException If {@code documentTryLimit} is less than one.
*/
public SearchIndexingBufferedSenderOptions<T> setMaxRetries(Integer maxRetries) {
if (maxRetries != null && maxRetries < 1) {
public SearchIndexingBufferedSenderOptions<T> setMaxRetries(int maxRetries) {
if (maxRetries < 1) {
throw logger.logExceptionAsError(
new IllegalArgumentException("'maxRetries' cannot be less than one."));
}
Expand All @@ -158,7 +159,7 @@ public SearchIndexingBufferedSenderOptions<T> setMaxRetries(Integer maxRetries)
* @return The number of times a document will attempt indexing.
*/
public int getMaxRetries() {
return (maxRetries == null) ? DEFAULT_MAX_RETRIES : maxRetries;
return maxRetries;
}

/**
Expand Down Expand Up @@ -198,7 +199,8 @@ public Duration getRetryDelay() {
*
* @param maxRetryDelay The maximum duration requests will delay when the service is throttling.
* @return The updated SearchIndexingBufferedSenderOptions object.
* @throws IllegalArgumentException If {@code maxRetryDelay.isNegative()} or {@code maxRetryDelay.isZero()} is true.
* @throws IllegalArgumentException If {@code maxRetryDelay.isNegative()} or {@code maxRetryDelay.isZero()} is
* true.
*/
public SearchIndexingBufferedSenderOptions<T> setMaxRetryDelay(Duration maxRetryDelay) {
if (maxRetryDelay != null && (maxRetryDelay.isNegative() || maxRetryDelay.isZero())) {
Expand Down
6 changes: 0 additions & 6 deletions ...ts/src/test/java/com/azure/search/documents/SearchIndexingBufferedSenderOptionsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,6 @@ public void flushWindowDefaults() {
public void initialBatchActionCountDefaults() {
SearchIndexingBufferedSenderOptions<Integer> options = new SearchIndexingBufferedSenderOptions<>();
assertEquals(512, options.getInitialBatchActionCount());

options.setInitialBatchActionCount(null);
assertEquals(512, options.getInitialBatchActionCount());
}

@Test
Expand All @@ -53,9 +50,6 @@ public void invalidBatchSizeThrows() {
public void maxRetriesDefaults() {
SearchIndexingBufferedSenderOptions<Integer> options = new SearchIndexingBufferedSenderOptions<>();
assertEquals(3, options.getMaxRetries());

options.setMaxRetries(null);
assertEquals(3, options.getMaxRetries());
}

@Test
Expand Down