Skip to main content

lb_traffic_extensions

Creates, updates, deletes, gets or lists a lb_traffic_extensions resource.

Overview​

Namelb_traffic_extensions
TypeResource
Idgoogle.networkservices.lb_traffic_extensions

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringRequired. Identifier. Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.
createTimestring (google-datetime)Output only. The timestamp when the resource was created.
descriptionstringOptional. A human-readable description of the resource.
extensionChainsarrayRequired. 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.
forwardingRulesarrayOptional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one LbTrafficExtension resource can be associated with a forwarding rule.
labelsobjectOptional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the requirements for labels for Google Cloud resources.
loadBalancingSchemestringRequired. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED and EXTERNAL_MANAGED. For more information, refer to Backend services overview.
metadataobjectOptional. 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 applies to all extensions in all extensions chains in this resource. The metadata is available under the key com.google.lb_traffic_extension.. The following variables are supported in the metadata: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.
updateTimestring (google-datetime)Output only. The timestamp when the resource was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, lbTrafficExtensionsIdGets details of the specified LbTrafficExtension resource.
listselectprojectsId, locationsIdpageSize, pageToken, filter, orderByLists LbTrafficExtension resources in a given project and location.
createinsertprojectsId, locationsIdlbTrafficExtensionId, requestIdCreates a new LbTrafficExtension resource in a given project and location.
patchupdateprojectsId, locationsId, lbTrafficExtensionsIdupdateMask, requestIdUpdates the parameters of the specified LbTrafficExtension resource.
deletedeleteprojectsId, locationsId, lbTrafficExtensionsIdrequestIdDeletes the specified LbTrafficExtension resource.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
lbTrafficExtensionsIdstring
locationsIdstring
projectsIdstring
filterstring
lbTrafficExtensionIdstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
requestIdstring
updateMaskstring (google-fieldmask)

SELECT examples​

Gets details of the specified LbTrafficExtension resource.

SELECT
name,
createTime,
description,
extensionChains,
forwardingRules,
labels,
loadBalancingScheme,
metadata,
updateTime
FROM google.networkservices.lb_traffic_extensions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND lbTrafficExtensionsId = '{{ lbTrafficExtensionsId }}' -- required;

INSERT examples​

Creates a new LbTrafficExtension resource in a given project and location.

INSERT INTO google.networkservices.lb_traffic_extensions (
data__name,
data__description,
data__labels,
data__forwardingRules,
data__extensionChains,
data__loadBalancingScheme,
data__metadata,
projectsId,
locationsId,
lbTrafficExtensionId,
requestId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ forwardingRules }}',
'{{ extensionChains }}',
'{{ loadBalancingScheme }}',
'{{ metadata }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ lbTrafficExtensionId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates the parameters of the specified LbTrafficExtension resource.

UPDATE google.networkservices.lb_traffic_extensions
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__forwardingRules = '{{ forwardingRules }}',
data__extensionChains = '{{ extensionChains }}',
data__loadBalancingScheme = '{{ loadBalancingScheme }}',
data__metadata = '{{ metadata }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND lbTrafficExtensionsId = '{{ lbTrafficExtensionsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes the specified LbTrafficExtension resource.

DELETE FROM google.networkservices.lb_traffic_extensions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND lbTrafficExtensionsId = '{{ lbTrafficExtensionsId }}' --required
AND requestId = '{{ requestId }}';