Reference documentation and code samples for the Google Cloud Network Services V1 Client class 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.
Generated from protobuf message google.cloud.networkservices.v1.Gateway
Namespace
Google \ Cloud \ NetworkServices \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>
.
↳ self_link
string
Output only. Server-defined URL of this resource
↳ create_time
↳ update_time
↳ labels
array| Google\Protobuf\Internal\MapField
Optional. Set of label tags associated with the Gateway resource.
↳ description
string
Optional. A free-text description of the resource. Max length 1024 characters.
↳ type
int
Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
↳ addresses
array
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
array
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.
↳ server_tls_policy
string
Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
↳ certificate_urls
array
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
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".
↳ ip_version
int
Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
↳ envoy_headers
int
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.
↳ routing_mode
int
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.
getName
Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>
.
string
setName
Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>
.
var
string
$this
getSelfLink
Output only. Server-defined URL of this resource
string
setSelfLink
Output only. Server-defined URL of this resource
var
string
$this
getCreateTime
Output only. The timestamp when the resource was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
$this
getUpdateTime
Output only. The timestamp when the resource was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was updated.
$this
getLabels
Optional. Set of label tags associated with the Gateway resource.
setLabels
Optional. Set of label tags associated with the Gateway resource.
$this
getDescription
Optional. A free-text description of the resource. Max length 1024 characters.
string
setDescription
Optional. A free-text description of the resource. Max length 1024 characters.
var
string
$this
getType
Immutable. The type of the customer managed gateway.
This field is required. If unspecified, an error is returned.
int
setType
Immutable. The type of the customer managed gateway.
This field is required. If unspecified, an error is returned.
var
int
$this
getAddresses
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.
setAddresses
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.
var
string[]
$this
getPorts
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.
setPorts
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.
var
int[]
$this
getScope
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.
string
setScope
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.
var
string
$this
getServerTlsPolicy
Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
string
setServerTlsPolicy
Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
var
string
$this
getCertificateUrls
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'.
setCertificateUrls
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'.
var
string[]
$this
getGatewaySecurityPolicy
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'.
string
setGatewaySecurityPolicy
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'.
var
string
$this
getNetwork
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'.
string
setNetwork
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'.
var
string
$this
getSubnetwork
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".
string
setSubnetwork
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".
var
string
$this
getIpVersion
Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
int
setIpVersion
Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
var
int
$this
getEnvoyHeaders
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.
int
hasEnvoyHeaders
clearEnvoyHeaders
setEnvoyHeaders
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.
var
int
$this
getRoutingMode
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.
int
setRoutingMode
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.
var
int
$this
