Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::TcpRoute.
TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when the resource was created.
#description
def description() -> ::String
Returns
- (::String) — Optional. A free-text description of the resource. Max length 1024 characters.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. A free-text description of the resource. Max length 1024 characters.
Returns
- (::String) — Optional. A free-text description of the resource. Max length 1024 characters.
#gateways
def gateways() -> ::Array<::String>
Returns
-
(::Array<::String>) — 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>
#gateways=
def gateways=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) — 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
-
(::Array<::String>) — 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
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the TcpRoute resource.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the TcpRoute resource.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the TcpRoute resource.
#meshes
def meshes() -> ::Array<::String>
Returns
-
(::Array<::String>) — 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
#meshes=
def meshes=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) — 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
-
(::Array<::String>) — 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
#name
def name() -> ::String
Returns
-
(::String) — Required. Name of the TcpRoute resource. It matches pattern
projects/*/locations/global/tcpRoutes/tcp_route_name>.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. Name of the TcpRoute resource. It matches pattern
projects/*/locations/global/tcpRoutes/tcp_route_name>.
Returns
-
(::String) — Required. Name of the TcpRoute resource. It matches pattern
projects/*/locations/global/tcpRoutes/tcp_route_name>.
#rules
def rules() -> ::Array<::Google::Cloud::NetworkServices::V1::TcpRoute::RouteRule>
Returns
- (::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.
#rules=
def rules=(value) -> ::Array<::Google::Cloud::NetworkServices::V1::TcpRoute::RouteRule>
Parameter
- value (::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.
Returns
- (::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.
#self_link
def self_link() -> ::String
Returns
- (::String) — Output only. Server-defined URL of this resource
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when the resource was updated.