feat: add support for customer headers / idemptotency key#335
Open
cbarton wants to merge 2 commits into
Open
Conversation
Every operation on the client has an overload that accepts a `RequestOptions` object. Use it to set
per-request options such as an idempotency key.
Idempotency Keys
```java
import com.recurly.v3.RequestOptions;
import com.recurly.v3.requests.AccountCreate;
import com.recurly.v3.resources.Account;
final AccountCreate accountReq = new AccountCreate();
accountReq.setCode("myaccountcode");
final RequestOptions options = RequestOptions.builder()
.idempotencyKey("unique-key-for-this-operation");
final Account account = client.createAccount(accountReq, options);
```
Custom Headers
```java
final RequestOptions options = RequestOptions.builder()
.header("X-Custom-Header", "value")
.header("X-Another-Header", "other-value");
final Account account = client.createAccount(accountReq, options);
```
Options can be combined — `idempotencyKey` and `header` calls chain together:
```java
final RequestOptions options = RequestOptions.builder()
.idempotencyKey("unique-key")
.header("X-Custom-Header", "value");
```
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Every operation on the client has an overload that accepts a
RequestOptionsobject. Use it to set per-request options such as an idempotency key.Idempotency Keys
Custom Headers
Options can be combined —
idempotencyKeyandheadercalls chain together: