Class Gateway (0.5.23) 

Gateway(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
name str
Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.
self_link str
Output only. Server-defined URL of this resource
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when the resource was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when the resource was updated.
labels MutableMapping[str, str]
Optional. Set of label tags associated with the Gateway resource.
description str
Optional. A free-text description of the resource. Max length 1024 characters.
type_ google.cloud.network_services_v1.types.Gateway.Type
Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
addresses MutableSequence[str]
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 MutableSequence[int]
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 str
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.
server_tls_policy str
Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
certificate_urls MutableSequence[str]
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'.
gateway_security_policy str
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 str
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 str
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".
ip_version google.cloud.network_services_v1.types.Gateway.IpVersion
Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
envoy_headers google.cloud.network_services_v1.types.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. This field is a member of oneof_ _envoy_headers.
routing_mode google.cloud.network_services_v1.types.Gateway.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.

Classes

IpVersion

IpVersion(value)

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

  • IPV4
  • IPV6

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, .Message]

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 mapping is a mapping type or there are keyword parameters.

RoutingMode

RoutingMode(value)

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

Type

Type(value)

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

  • OPEN_MESH
  • SECURE_WEB_GATEWAY