Skip to main content

gateways

Overview

Namegateways
TypeResource
Idgoogle.networkservices.gateways

Fields

NameDatatypeDescription
namestringRequired. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.
descriptionstringOptional. A free-text description of the resource. Max length 1024 characters.
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 coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.
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 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.
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'.
serverTlsPolicystringOptional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
createTimestringOutput only. The timestamp when the resource was created.
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.
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".
labelsobjectOptional. Set of label tags associated with the Gateway resource.
typestringImmutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
selfLinkstringOutput only. Server-defined URL of this resource
updateTimestringOutput only. The timestamp when the resource was updated.
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'.
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'.

Methods

NameAccessible byRequired ParamsDescription
getSELECTgatewaysId, locationsId, projectsIdGets details of a single Gateway.
listSELECTlocationsId, projectsIdLists Gateways in a given project and location.
createINSERTlocationsId, projectsIdCreates a new Gateway in a given project and location.
deleteDELETEgatewaysId, locationsId, projectsIdDeletes a single Gateway.
_listEXEClocationsId, projectsIdLists Gateways in a given project and location.
patchEXECgatewaysId, locationsId, projectsIdUpdates the parameters of a single Gateway.