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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Name of the Gateway resource. It matches pattern |
↳ self_link |
string
Output only. Server-defined URL of this resource |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was updated. |
↳ 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: |
↳ network |
string
Optional. The relative resource name identifying the VPC network that is using this configuration. For example: |
↳ subnetwork |
string
Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: |
↳ 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>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Name of the Gateway resource. It matches pattern
projects/*/locations/*/gateways/<gateway_name>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
Output only. Server-defined URL of this resource
| Returns | |
|---|---|
| Type | Description |
string |
|
setSelfLink
Output only. Server-defined URL of this resource
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The timestamp when the resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp when the resource was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Set of label tags associated with the Gateway resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Set of label tags associated with the Gateway resource.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A free-text description of the resource. Max length 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A free-text description of the resource. Max length 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Immutable. The type of the customer managed gateway.
This field is required. If unspecified, an error is returned.
| Returns | |
|---|---|
| Type | Description |
int |
|
setType
Immutable. The type of the customer managed gateway.
This field is required. If unspecified, an error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServerTlsPolicy
Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServerTlsPolicy
Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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'.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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'.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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'.
| Returns | |
|---|---|
| Type | Description |
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'.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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'.
| Returns | |
|---|---|
| Type | Description |
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'.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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".
| Returns | |
|---|---|
| Type | Description |
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".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIpVersion
Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
| Returns | |
|---|---|
| Type | Description |
int |
|
setIpVersion
Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|