Skip to content

chore:Update java docs for v5 release #607

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

Merged
merged 1 commit into from
Feb 27, 2025
Merged

chore:Update java docs for v5 release #607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions docs/sdks/server-sdks/java/bandits.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ In order for the bandit to learn an optimized policy, we need to capture and log
This requires defining a bandit logger in addition to an assignment logger.

```java
EppoClient.Builder()
.apiKey(apiKey)
EppoClient.builder(sdkKey)
.assignmentLogger(assignmentLogData -> {
System.out.println("TODO: send assignment event data to data warehouse: " + assignmentLogData);
})
Expand Down
10 changes: 4 additions & 6 deletions docs/sdks/server-sdks/java/initialization.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@ The Eppo Java SDK is easy to initialize while offering robust customization opti
To complete basic initialization, you only need to provide an SDK key. [Create an SDK key](/sdks/sdk-keys) if you don't already have one.

```java
EppoClient.Builder()
.apiKey(apiKey)
EppoClient.builder(sdkKey)
.buildAndInit();
```

<ApiOptionRef
name="apiKey"
name="sdkKey"
type="string"
>
Your SDK key. [Create an SDK key](/sdks/sdk-keys) if you don't already have one.
Expand Down Expand Up @@ -94,8 +93,7 @@ Basic initialization is great for most use cases, but the SDK provides options t
Here's an example of using multiple configuration options:

```java
EppoClient.Builder()
.apiKey(apiKey)
EppoClient.builder(sdkKey)
.gracefulMode(true)
.pollingIntervalMs(60000) // Poll every minute
.assignmentLogger(assignmentLogData -> {
Expand All @@ -118,5 +116,5 @@ The SDK provides several utility methods that can be useful:
eppoClient.setIsGracefulFailureMode(false);

// Stop polling for configuration updates
EppoClient.stopPolling();
eppoClient.stopPolling();
```
14 changes: 5 additions & 9 deletions docs/sdks/server-sdks/java/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can install the SDK using Gradle or Maven:
<TabItem value="gradle" label="Gradle">

```groovy
implementation 'cloud.eppo:eppo-server-sdk:3.5.3'
implementation 'cloud.eppo:eppo-server-sdk:5.0.0'
```

</TabItem>
Expand All @@ -26,7 +26,7 @@ implementation 'cloud.eppo:eppo-server-sdk:3.5.3'
<dependency>
<groupId>cloud.eppo</groupId>
<artifactId>eppo-server-sdk</artifactId>
<version>3.0.1</version>
<version>5.0.0</version>
</dependency>
```

Expand All @@ -42,9 +42,7 @@ implementation 'cloud.eppo:eppo-server-sdk:3.5.3'
Initialize the SDK with your key:

```java
EppoClient eppoClient = EppoClient.Builder()
.apiKey(sdkKey)
.buildAndInit();
EppoClient eppoClient = EppoClient.builder(sdkKey).buildAndInit();
```

### Assign a variant
Expand Down Expand Up @@ -91,8 +89,7 @@ The SDK provides different assignment functions based on the type of value you n
For experiments, you'll need to add an assignment logger (see [`AssignmentLogger`](/sdks/server-sdks/java/assignments#assignment-logger)) when initializing the SDK:

```java
EppoClient.Builder()
.apiKey(apiKey)
EppoClient.builder(sdkKey)
.assignmentLogger(assignmentLogData -> {
// TODO: Send assignment event data to data warehouse
System.out.println(assignmentLogData);
Expand All @@ -107,8 +104,7 @@ After that, you can make assignments the same way as with feature flags.
For bandits, you'll need both an [`assignment logger`](/sdks/server-sdks/java/assignments#assignment-logger) and a [`bandit logger`](/sdks/server-sdks/java/bandits#define-a-bandit-assignment-logger):

```java
EppoClient.Builder()
.apiKey(apiKey)
EppoClient.builder(sdkKey)
.assignmentLogger(assignmentLogData -> {
// TODO: Send assignment event data to data warehouse
System.out.println(assignmentLogData);
Expand Down