Skip to content

Commit aec6144

Browse files
committed
Be more verbose about types returned by read()
1 parent d433e8e commit aec6144

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,21 @@ 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.
63+
64+
[doppler-pkg]: https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-client/latest/org/cloudfoundry/doppler/package-summary.html
65+
[logcache-pkg]: https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-client/latest/org/cloudfoundry/logcache/v1/package-summary.html
5166
5267
> [!NOTE]
5368
> **Operations API users:** `Applications.logs(ApplicationLogsRequest)` now uses Log Cache under the hood for recent logs (the default). No migration is needed at the Operations layer.

0 commit comments

Comments
 (0)