Gateway(mapping=None, *, ignore_unknown_fields=False, **kwargs)A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Created time. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Updated time. |
labels |
MutableMapping[str, str]
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
display_name |
str
Optional. Display name. |
api_config |
str
Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig} |
state |
google.cloud.apigateway_v1.types.Gateway.State
Output only. The current state of the Gateway. |
default_hostname |
str
Output only. The default hostname that serves traffic for this Gateway. |
streaming_mode |
google.cloud.apigateway_v1.types.Gateway.StreamingMode
Optional. Immutable. 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.
|
effective_streaming_mode |
google.cloud.apigateway_v1.types.Gateway.EffectiveStreamingMode
Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from streaming_mode, the referenced API Config, and the
platform default at the time. Read this rather than
streaming_mode to determine whether a gateway supports
streaming.
|
Classes
EffectiveStreamingMode
EffectiveStreamingMode(value)The streaming mode a Gateway is served with. This enum is frozen. No values are expected to be added in the future.
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
State
State(value)All the possible Gateway states.
StreamingMode
StreamingMode(value)Streaming mode for a Gateway. This enum is frozen. No values are expected to be added in the future.
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.