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
Required. 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. |
↳ ports |
array
Required. One or more ports that the Gateway must receive traffic on. The proxy binds to the ports specified. Gateway listen on 0.0.0.0 on the ports specified below. |
↳ scope |
string
Required. Immutable. 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. |
↳ server_tls_policy |
string
Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. |
getName
Required. Name of the Gateway resource. It matches pattern
projects/*/locations/*/gateways/<gateway_name>
.
Returns | |
---|---|
Type | Description |
string |
setName
Required. 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 |
getPorts
Required. One or more ports that the Gateway must receive traffic on. The proxy binds to the ports specified. Gateway listen on 0.0.0.0 on the ports specified below.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setPorts
Required. One or more ports that the Gateway must receive traffic on. The proxy binds to the ports specified. Gateway listen on 0.0.0.0 on the ports specified below.
Parameter | |
---|---|
Name | Description |
var |
int[]
|
Returns | |
---|---|
Type | Description |
$this |
getScope
Required. Immutable. 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.
Returns | |
---|---|
Type | Description |
string |
setScope
Required. Immutable. 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.
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 |