Skip to content

Commit 3731bde

Browse files
committed
Update README versions to mention 5.x and 6.x
1 parent 251f257 commit 3731bde

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The `cf-java-client` project is a Java language binding for interacting with a C
1515
* `cloudfoundry-operations` – An API and implementation that corresponds to the [Cloud Foundry CLI][c] operations. This project builds on the `cloudfoundry-client` and therefore has a single implementation.
1616

1717
## Versions
18-
The Cloud Foundry Java Client has two active versions. The `5.x` line is compatible with Spring Boot `2.4.x - 2.6.x` just to manage its dependencies, while the `4.x` line uses Spring Boot `2.3.x`.
18+
The Cloud Foundry Java Client has two active versions. The `6.x` line includes breaking changes (see below), while the `5.x` line maintains backward compatibility.
1919

2020
## Breaking Changes (6.x)
2121

@@ -48,6 +48,18 @@ The Cloud Foundry Java Client has two active versions. The `5.x` line is compati
4848
> .envelopeTypes(EnvelopeType.LOG)
4949
> .build());
5050
> ```
51+
>
52+
> The return type and envelope objects differ between the two APIs:
53+
>
54+
> | | Doppler (`org.cloudfoundry.doppler`) | Log Cache (`org.cloudfoundry.logcache.v1`) |
55+
> |---|---|---|
56+
> | **Return type** | `Flux<Envelope>` | `Mono<ReadResponse>` → unpack via `response.getEnvelopes().getBatch()` |
57+
> | **Log access** | `envelope.getLogMessage()` → `LogMessage` | `envelope.getLog()` → `Log` |
58+
> | **Message text** | `logMessage.getMessage()` | `log.getPayloadAsText()` |
59+
> | **Message type** | `MessageType.OUT` / `ERR` | `LogType.OUT` / `ERR` |
60+
> | **Source metadata** | `logMessage.getSourceType()`, `.getSourceInstance()` | `envelope.getTags().get("source_type")`, `envelope.getInstanceId()` |
61+
>
62+
> See the [`org.cloudfoundry.doppler`][doppler-pkg] and [`org.cloudfoundry.logcache.v1`][logcache-pkg] Javadoc for full type details.
5163
5264
> [!NOTE]
5365
> **Operations API users:** Use `Applications.logs(ApplicationLogsRequest)` instead of the removed `Applications.logs(LogsRequest)`.

0 commit comments

Comments
 (0)