Reference documentation and code samples for the Google Cloud Network Services V1 Client class LbTrafficExtension.
LbTrafficExtension
is a resource that lets the extension service modify the
headers and payloads of both requests and responses without impacting the
choice of backend services or any other security policies associated with the
backend service.
Generated from protobuf message google.cloud.networkservices.v1.LbTrafficExtension
Namespace
Google \ Cloud \ NetworkServices \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Identifier. Name of the |
↳ 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 |
↳ 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 |
↳ extension_chains |
array<Google\Cloud\NetworkServices\V1\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: |
↳ metadata |
Google\Protobuf\Struct
Optional. The metadata provided here is included in the |
getName
Required. Identifier. Name of the LbTrafficExtension
resource in the
following format:
projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}
.
Returns | |
---|---|
Type | Description |
string |
setName
Required. Identifier. Name of the LbTrafficExtension
resource in the
following format:
projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_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 LbTrafficExtension
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 LbTrafficExtension
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 LBTrafficExtension
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 LBTrafficExtension
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<Google\Cloud\NetworkServices\V1\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 in the
ProcessingRequest.metadata_context.filter_metadata
map field. The
metadata is available under the key
com.google.lb_traffic_extension.<resource_name>
.
The following variables are supported in the metadata:
{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 in the
ProcessingRequest.metadata_context.filter_metadata
map field. The
metadata is available under the key
com.google.lb_traffic_extension.<resource_name>
.
The following variables are supported in the metadata:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Struct
|
Returns | |
---|---|
Type | Description |
$this |