Google Cloud Network Services V1 Client - Class TcpRoute (0.1.1)

Version 0.1.1

• 0.2.0 (latest)
• 0.1.1

Reference documentation and code samples for the Google Cloud Network Services V1 Client class TcpRoute.

TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource.

Generated from protobuf message google.cloud.networkservices.v1.TcpRoute

Namespace

Google \ Cloud \ NetworkServices \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. Name of the TcpRoute resource. It matches pattern projects/*/locations/global/tcpRoutes/tcp_route_name>.
↳ 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.
↳ description	string Optional. A free-text description of the resource. Max length 1024 characters.
↳ rules	array<Google\Cloud\NetworkServices\V1\TcpRoute\RouteRule> Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match.
↳ meshes	array Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> The attached Mesh should be of a type SIDECAR
↳ gateways	array Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>
↳ labels	array|Google\Protobuf\Internal\MapField Optional. Set of label tags associated with the TcpRoute resource.

getName

Required. Name of the TcpRoute resource. It matches pattern projects/*/locations/global/tcpRoutes/tcp_route_name>.

Returns
Type	Description
string

setName

Required. Name of the TcpRoute resource. It matches pattern projects/*/locations/global/tcpRoutes/tcp_route_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

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

getRules

Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRules

Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match.

Parameter
Name	Description
var	array<Google\Cloud\NetworkServices\V1\TcpRoute\RouteRule>

Returns
Type	Description
$this

getMeshes

Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh.

Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> The attached Mesh should be of a type SIDECAR

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setMeshes

Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh.

Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> The attached Mesh should be of a type SIDECAR

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getGateways

Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway.

Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setGateways

Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway.

Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getLabels

Optional. Set of label tags associated with the TcpRoute resource.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Set of label tags associated with the TcpRoute resource.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this