Skip to main content

gateways

Creates, updates, deletes, gets or lists a gateways resource.

Overview​

Namegateways
TypeResource
Idgoogle.networkservices.gateways

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringIdentifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.
addressesarrayOptional. 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.
allPortsbooleanOptional. If true, the Gateway will listen on all ports. This is mutually exclusive with the ports field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'.
allowGlobalAccessbooleanOptional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY.
certificateUrlsarrayOptional. 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'.
createTimestring (google-datetime)Output only. The timestamp when the resource was created.
descriptionstringOptional. A free-text description of the resource. Max length 1024 characters.
envoyHeadersstringOptional. 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. (ENVOY_HEADERS_UNSPECIFIED, NONE, DEBUG_HEADERS)
gatewaySecurityPolicystringOptional. 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'.
ipVersionstringOptional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4. (IP_VERSION_UNSPECIFIED, IPV4, IPV6)
labelsobjectOptional. Set of label tags associated with the Gateway resource.
networkstringOptional. 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'.
portsarrayRequired. 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 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.
routingModestringOptional. 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. (EXPLICIT_ROUTING_MODE, NEXT_HOP_ROUTING_MODE)
scopestringOptional. 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.
selfLinkstringOutput only. Server-defined URL of this resource
serverTlsPolicystringOptional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
subnetworkstringOptional. 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".
typestringImmutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned. (TYPE_UNSPECIFIED, OPEN_MESH, SECURE_WEB_GATEWAY)
updateTimestring (google-datetime)Output only. The timestamp when the resource was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, gatewaysIdGets details of a single Gateway.
listselectprojectsId, locationsIdpageSize, pageTokenLists Gateways in a given project and location.
createinsertprojectsId, locationsIdgatewayIdCreates a new Gateway in a given project and location.
patchupdateprojectsId, locationsId, gatewaysIdupdateMaskUpdates the parameters of a single Gateway.
deletedeleteprojectsId, locationsId, gatewaysIdDeletes a single Gateway.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
gatewaysIdstring
locationsIdstring
projectsIdstring
gatewayIdstring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)

SELECT examples​

Gets details of a single Gateway.

SELECT
name,
addresses,
allPorts,
allowGlobalAccess,
certificateUrls,
createTime,
description,
envoyHeaders,
gatewaySecurityPolicy,
ipVersion,
labels,
network,
ports,
routingMode,
scope,
selfLink,
serverTlsPolicy,
subnetwork,
type,
updateTime
FROM google.networkservices.gateways
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND gatewaysId = '{{ gatewaysId }}' -- required
;

INSERT examples​

Creates a new Gateway in a given project and location.

INSERT INTO google.networkservices.gateways (
data__name,
data__labels,
data__description,
data__type,
data__addresses,
data__ports,
data__allPorts,
data__scope,
data__serverTlsPolicy,
data__certificateUrls,
data__gatewaySecurityPolicy,
data__network,
data__subnetwork,
data__ipVersion,
data__envoyHeaders,
data__routingMode,
data__allowGlobalAccess,
projectsId,
locationsId,
gatewayId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ type }}',
'{{ addresses }}',
'{{ ports }}',
{{ allPorts }},
'{{ scope }}',
'{{ serverTlsPolicy }}',
'{{ certificateUrls }}',
'{{ gatewaySecurityPolicy }}',
'{{ network }}',
'{{ subnetwork }}',
'{{ ipVersion }}',
'{{ envoyHeaders }}',
'{{ routingMode }}',
{{ allowGlobalAccess }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ gatewayId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates the parameters of a single Gateway.

UPDATE google.networkservices.gateways
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__type = '{{ type }}',
data__addresses = '{{ addresses }}',
data__ports = '{{ ports }}',
data__allPorts = {{ allPorts }},
data__scope = '{{ scope }}',
data__serverTlsPolicy = '{{ serverTlsPolicy }}',
data__certificateUrls = '{{ certificateUrls }}',
data__gatewaySecurityPolicy = '{{ gatewaySecurityPolicy }}',
data__network = '{{ network }}',
data__subnetwork = '{{ subnetwork }}',
data__ipVersion = '{{ ipVersion }}',
data__envoyHeaders = '{{ envoyHeaders }}',
data__routingMode = '{{ routingMode }}',
data__allowGlobalAccess = {{ allowGlobalAccess }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND gatewaysId = '{{ gatewaysId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a single Gateway.

DELETE FROM google.networkservices.gateways
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND gatewaysId = '{{ gatewaysId }}' --required
;