Reference documentation and code samples for the API Gateway V1 API module Google::Cloud::ApiGateway::V1::Gateway::StreamingMode.
Streaming mode for a Gateway. This enum is frozen. No values are expected to be added in the future.
Constants
STREAMING_MODE_UNSPECIFIED
value: 0
Lets the service select the streaming mode.
STREAMING_MODE_ENABLED
value: 1
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.