core: Document grpc does not perform compression nego on client

This commit is contained in:
Eric Anderson 2019-03-11 11:32:34 -07:00
parent 656dcc1c7c
commit 57e94d19ea
1 changed files with 4 additions and 0 deletions

View File

@ -105,6 +105,10 @@ public final class CallOptions {
/**
* Sets the compression to use for the call. The compressor must be a valid name known in the
* {@link CompressorRegistry}.
*
* <p>It is only safe to call this if the server supports the compression format chosen. There is
* no negotiation performed; if the server does not support the compression chosen, the call will
* fail.
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1704")
public CallOptions withCompression(@Nullable String compressorName) {