Google Cloud Network Services V1 Client - Class LbRouteExtension (0.2.1)

Version latest

• 0.2.1 (latest)
• 0.2.0
• 0.1.1

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

LbRouteExtension is a resource that lets you control where traffic is routed to for a given request.

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

Namespace

Google \ Cloud \ NetworkServices \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. Identifier. Name of the LbRouteExtension resource in the following format: projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}.
↳ 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 human-readable description of the resource.
↳ labels	array|Google\Protobuf\Internal\MapField Optional. Set of labels associated with the LbRouteExtension resource. The format must comply with the requirements for labels for Google Cloud resources.
↳ forwarding_rules	array Required. A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LbRouteExtension resource per forwarding rule.
↳ extension_chains	array<ExtensionChain> Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
↳ load_balancing_scheme	int Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.
↳ metadata	Google\Protobuf\Struct Optional. The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.lb_route_extension.<resource_name>. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

getName

Required. Identifier. Name of the LbRouteExtension resource in the following format: projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}.

Returns
Type	Description
string

setName

Required. Identifier. Name of the LbRouteExtension resource in the following format: projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}.

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 human-readable description of the resource.

Returns
Type	Description
string

setDescription

Optional. A human-readable description of the resource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLabels

Optional. Set of labels associated with the LbRouteExtension resource.

The format must comply with the requirements for labels for Google Cloud resources.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Set of labels associated with the LbRouteExtension resource.

The format must comply with the requirements for labels for Google Cloud resources.

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

Returns
Type	Description
$this

getForwardingRules

Required. A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required.

There can be only one LbRouteExtension resource per forwarding rule.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setForwardingRules

Required. A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required.

There can be only one LbRouteExtension resource per forwarding rule.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getExtensionChains

Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed.

Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setExtensionChains

Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed.

Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.

Parameter
Name	Description
var	array<ExtensionChain>

Returns
Type	Description
$this

getLoadBalancingScheme

Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.

Returns
Type	Description
int

setLoadBalancingScheme

Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMetadata

Optional. The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.lb_route_extension.<resource_name>.

The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

Returns
Type	Description
Google\Protobuf\Struct|null

hasMetadata

clearMetadata

setMetadata

Optional. The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.lb_route_extension.<resource_name>.

The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

Parameter
Name	Description
var	Google\Protobuf\Struct

Returns
Type	Description
$this