feat(java): add requestOptions
#487
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package com.algolia.utils; | ||
|
|
||
| import java.io.Serializable; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import javax.annotation.Nonnull; | ||
|
|
||
| /** | ||
| * Request options are used to pass extra parameters, headers, timeout to the request. Parameters | ||
| * set in the request option will override default parameter. | ||
| */ | ||
| public class RequestOptions implements Serializable { | ||
shortcuts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private final Map<String, String> headers = new HashMap<String, String>(); | ||
| private final Map<String, String> queryParams = new HashMap<String, String>(); | ||
| private Integer timeout = null; | ||
|
|
||
| public RequestOptions addExtraHeader( | ||
| @Nonnull String key, | ||
| @Nonnull String value | ||
| ) { | ||
| headers.put(key, value); | ||
| return this; | ||
| } | ||
|
|
||
| public RequestOptions addExtraQueryParameters( | ||
| @Nonnull String key, | ||
| @Nonnull String value | ||
| ) { | ||
| queryParams.put(key, value); | ||
| return this; | ||
| } | ||
|
|
||
| public Map<String, String> getExtraHeaders() { | ||
| return headers; | ||
| } | ||
|
|
||
| public Map<String, String> getExtraQueryParams() { | ||
| return queryParams; | ||
| } | ||
|
|
||
| public Integer getTimeout() { | ||
| return timeout; | ||
| } | ||
|
|
||
| public RequestOptions setTimeout(Integer timeout) { | ||
| this.timeout = timeout; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return ( | ||
| "RequestOptions{" + | ||
| "headers=" + | ||
| headers + | ||
| ", queryParams=" + | ||
| queryParams + | ||
| '\'' + | ||
| '}' | ||
| ); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,7 @@ import {{modelPackage}}.*; | |
| import com.algolia.exceptions.*; | ||
| import com.algolia.utils.retry.CallType; | ||
| import com.algolia.utils.retry.StatefulHost; | ||
| import com.algolia.utils.RequestOptions; | ||
|
|
||
| import java.util.EnumSet; | ||
| import java.util.Random; | ||
|
|
@@ -99,6 +100,7 @@ public class {{classname}} extends ApiClient { | |
| /** | ||
| * {{¬es}}{{#allParams}} | ||
| * @param {{paramName}} {{&description}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#returnType}} | ||
| * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. | ||
| * @return {{.}}{{/returnType}} | ||
| * @throws AlgoliaRuntimeException If fail to call the API, e.g. server error or cannot deserialize the response body | ||
| {{#isDeprecated}} | ||
|
|
@@ -112,20 +114,27 @@ public class {{classname}} extends ApiClient { | |
| {{#isDeprecated}} | ||
| @Deprecated | ||
| {{/isDeprecated}} | ||
| public {{#returnType}}{{{.}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{operationId}}({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}RequestOptions requestOptions) throws AlgoliaRuntimeException { | ||
| return LaunderThrowable.await({{operationId}}Async({{#allParams}}{{paramName}}, {{/allParams}}requestOptions)); | ||
| } | ||
|
|
||
| {{! this case handle all the both optional parameters and `requestOptions` }} | ||
| {{#optionalParams.0}} | ||
| public {{#returnType}}{{{.}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{operationId}}({{#requiredParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}) throws AlgoliaRuntimeException { | ||
| {{#returnType}}return {{/returnType}}this.{{operationId}}({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}{{#optionalParams.0}},{{/optionalParams.0}} null); | ||
shortcuts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| {{/optionalParams.0}} | ||
|
|
||
| {{! This case only sets `requestOptions` as optional }} | ||
|
There was a problem hiding this comment. I don't think you need both, you can just keep the first one but always generate it, and if someone want's to provide There was a problem hiding this comment. I think both with #487 (comment) are fine to keep, it's a bit verbose but a pretty good addition |
||
| public {{#returnType}}{{{.}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{operationId}}({{#allParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}) throws AlgoliaRuntimeException { | ||
| {{#returnType}}return {{/returnType}}this.{{operationId}}({{#allParams}}{{paramName}}, {{/allParams}}null); | ||
| } | ||
|
|
||
| /** | ||
| * (asynchronously) | ||
| * {{notes}}{{#allParams}} | ||
| * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}} | ||
| * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. | ||
| * @return The awaitable future | ||
| * @throws AlgoliaRuntimeException If fail to process the API call, e.g. serializing the request body object | ||
| {{#isDeprecated}} | ||
|
|
@@ -139,7 +148,7 @@ public class {{classname}} extends ApiClient { | |
| {{#isDeprecated}} | ||
| @Deprecated | ||
| {{/isDeprecated}} | ||
| public CompletableFuture<{{{returnType}}}> {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}RequestOptions requestOptions) throws AlgoliaRuntimeException { | ||
|
There was a problem hiding this comment. If the async functions are widely used, maybe it would be worth it to also gave them alternative with optionals There was a problem hiding this comment. Do you mean all optionals or just the requestOptions part? There was a problem hiding this comment. There was a problem hiding this comment. The exact same as sync function, that mean:
There was a problem hiding this comment. Ah oki so I'm missing the last one for the async here There was a problem hiding this comment. Maybe we could also have only required alone actually, it makes more sense There was a problem hiding this comment. ok so sync and async function would need:
? There was a problem hiding this comment. sounds good ! you thinks it's okay or too much ? There was a problem hiding this comment. I think it's good, we could even have more cases but it should be enough There was a problem hiding this comment. The cases above are reflected here: ad0ff62 |
||
| {{#allParams}}{{#required}} | ||
| if ({{paramName}} == null) { | ||
| throw new AlgoliaRuntimeException("Missing the required parameter '{{paramName}}' when calling {{operationId}}(Async)"); | ||
|
|
@@ -176,7 +185,7 @@ public class {{classname}} extends ApiClient { | |
| } | ||
|
|
||
| {{/headerParams}} | ||
| Call call = this.buildCall(requestPath, "{{httpMethod}}", queryParams, bodyObj, headers, requestOptions); | ||
| Type returnType = new TypeToken<{{{returnType}}}>() {}.getType(); | ||
| return this.executeAsync(call, returnType); | ||
| } | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file copied from the current client implementation: https://github.com/algolia/algoliasearch-client-java-2/blob/master/algoliasearch-core/src/main/java/com/algolia/search/models/RequestOptions.java