REST Resource: projects.locations.gateways

Resource: Gateway

Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway.

JSON representation 
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "type": enum (Type),
  "addresses": [
    string
  ],
  "ports": [
    integer
  ],
  "scope": string,
  "serverTlsPolicy": string,
  "certificateUrls": [
    string
  ],
  "gatewaySecurityPolicy": string,
  "network": string,
  "subnetwork": string,
  "ipVersion": enum (IpVersion),
  "routingMode": enum (RoutingMode),
  "envoyHeaders": enum (EnvoyHeaders)
}
Fields
name

string

Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>.
createTime

string (Timestamp format)

Output only. The timestamp when the resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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. The timestamp when the resource was updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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. Set of label tags associated with the Gateway resource.

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

string

Optional. A free-text description of the resource. Max length 1024 characters.
type

enum (Type)

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
addresses[]

string

Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated

This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.
ports[]

integer

Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.
scope

string

Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single configuration to the proxy/load balancer.

Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.
serverTlsPolicy

string

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
certificateUrls[]

string

Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
gatewaySecurityPolicy

string

Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections.

For example: projects/*/locations/*/gatewaySecurityPolicies/swg-policy.

This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.
network

string

Optional. The relative resource name identifying the VPC network that is using this configuration. For example: projects/*/global/networks/network-1.

Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.
subnetwork

string

Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: projects/*/regions/us-central1/subnetworks/network-1

Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".
ipVersion

enum (IpVersion)

Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
routingMode

enum (RoutingMode)

Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY.
envoyHeaders

enum (EnvoyHeaders)

Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers.

Type

The type of the customer-managed gateway. Possible values are: * OPEN_MESH * SECURE_WEB_GATEWAY

Enums
TYPE_UNSPECIFIED The type of the customer managed gateway is unspecified.
OPEN_MESH The type of the customer managed gateway is TrafficDirector Open Mesh.
SECURE_WEB_GATEWAY The type of the customer managed gateway is SecureWebGateway (SWG).

IpVersion

The types of IP version for the gateway. Possible values are: * IPV4 * IPV6

Enums
IP_VERSION_UNSPECIFIED The type when IP version is not specified. Defaults to IPV4.
IPV4 The type for IP version 4.
IPV6 The type for IP version 6.

RoutingMode

The routing mode of the Gateway, to determine how the Gateway routes traffic. Today, this field only applies to Gateways of type SECURE_WEB_GATEWAY. Possible values are: * EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE

Enums
EXPLICIT_ROUTING_MODE The routing mode is explicit; clients are configured to send traffic through the gateway. This is the default routing mode.
NEXT_HOP_ROUTING_MODE The routing mode is next-hop. Clients are unaware of the gateway, and a route (advanced route or other route type) can be configured to direct traffic from client to gateway. The gateway then acts as a next-hop to the destination.

Methods

create

 Creates a new Gateway in a given project and location.

delete

 Deletes a single Gateway.

get

 Gets details of a single Gateway.

list

 Lists Gateways in a given project and location.

patch

 Updates the parameters of a single Gateway.