streamingMode property

String? streamingMode
getter/setter pair

Requests streaming for a new gateway.

An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read effective_streaming_mode for the mode the gateway is served with.

Optional. Immutable. Possible string values are:

  • "STREAMING_MODE_UNSPECIFIED" : Lets the service select the streaming mode.
  • "STREAMING_MODE_ENABLED" : Enables streaming. The gateway supports Server-Sent Events (SSE), HTTP/2 streaming, HTTP chunked transfer, WebSockets, and gRPC bidirectional streaming. The API config's backend deadline field governs how long a request (unary or streaming) may run. Enabling streaming on a gateway does not change how the deadline field behaves on an SSE or chunked-transfer path. The deadline remains a wall-clock bound on the complete response, so a stream is cut once the deadline elapses regardless of how much data it is sending. The default is 15 seconds and the maximum is 3,600 seconds. On gRPC streaming and WebSockets, deadline bounds the gap between messages instead: default 300 seconds; set deadline to change it, up to 3,600 seconds. On WebSockets, a deadline of less than 300 seconds is ignored and a 300-second minimum applies. The maximum total request duration is always 3,600 seconds, not configurable.

Implementation

core.String? streamingMode;