REST Resource: projects.locations.gateways

Resource: Gateway

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.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "apiConfig": string,
  "state": enum (State),
  "defaultHostname": string,
  "streamingMode": enum (StreamingMode),
  "effectiveStreamingMode": enum (EffectiveStreamingMode)
}
Fields
name

string

Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
createTime

string (Timestamp format)

Output only. Created time.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Updated time.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

Optional. Display name.
apiConfig

string

Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
state

enum (State)

Output only. The current state of the Gateway.
defaultHostname

string

Output only. The default hostname that serves traffic for this Gateway.
streamingMode

enum (StreamingMode)

Optional. Immutable. Requests response 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 effectiveStreamingMode for the mode the gateway is served with.
effectiveStreamingMode

enum (EffectiveStreamingMode)

Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from streamingMode, the referenced API Config, and the platform default at the time. Read this rather than streamingMode to determine whether a gateway supports response streaming.

State

All the possible Gateway states.

Enums
STATE_UNSPECIFIED Gateway does not have a state yet.
CREATING Gateway is being created.
ACTIVE Gateway is running and ready for requests.
FAILED Gateway creation failed.
DELETING Gateway is being deleted.
UPDATING Gateway is being updated.

StreamingMode

Streaming mode for a Gateway. This enum is frozen. No values are expected to be added in the future.

Enums
STREAMING_MODE_UNSPECIFIED The service selects the streaming mode.
STREAMING_MODE_ENABLED Streaming is enabled. The gateway supports response streaming: server-sent events, HTTP chunked transfer, WebSockets, and gRPC/HTTP2 bidirectional streaming.

EffectiveStreamingMode

The streaming mode a Gateway is served with. This enum is frozen. No values are expected to be added in the future.

Enums
EFFECTIVE_STREAMING_MODE_UNSPECIFIED The service has not resolved a mode. Every gateway returned by gateways.get and gateways.list carries a resolved mode, so this value should not be returned under normal circumstances.
EFFECTIVE_STREAMING_MODE_DISABLED The gateway does not support response streaming.
EFFECTIVE_STREAMING_MODE_ENABLED The gateway supports response streaming.

Methods

create

 Creates a new Gateway in a given project and location.

delete

 Deletes a single Gateway.

get

 Gets details of a single Gateway.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists Gateways in a given project and location.

patch

 Updates the parameters of a single Gateway.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.