lb_traffic_extensions
Creates, updates, deletes, gets or lists a lb_traffic_extensions resource.
Overview
| Name | lb_traffic_extensions |
| Type | Resource |
| Id | google.networkservices.lb_traffic_extensions |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
name | string | Required. Identifier. Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}. |
createTime | string (google-datetime) | Output only. The timestamp when the resource was created. |
description | string | Optional. A human-readable description of the resource. |
extensionChains | array | 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. |
forwardingRules | array | Optional. 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. |
labels | object | Optional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the requirements for labels for Google Cloud resources. |
loadBalancingScheme | string | Required. 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. |
metadata | object | 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 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. |
updateTime | string (google-datetime) | Output only. The timestamp when the resource was updated. |
| Name | Datatype | Description |
|---|---|---|
name | string | Required. Identifier. Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}. |
createTime | string (google-datetime) | Output only. The timestamp when the resource was created. |
description | string | Optional. A human-readable description of the resource. |
extensionChains | array | 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. |
forwardingRules | array | Optional. 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. |
labels | object | Optional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the requirements for labels for Google Cloud resources. |
loadBalancingScheme | string | Required. 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. |
metadata | object | 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 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. |
updateTime | string (google-datetime) | Output only. The timestamp when the resource was updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | projectsId, locationsId, lbTrafficExtensionsId | Gets details of the specified LbTrafficExtension resource. | |
list | select | projectsId, locationsId | pageSize, pageToken, filter, orderBy | Lists LbTrafficExtension resources in a given project and location. |
create | insert | projectsId, locationsId | lbTrafficExtensionId, requestId | Creates a new LbTrafficExtension resource in a given project and location. |
patch | update | projectsId, locationsId, lbTrafficExtensionsId | updateMask, requestId | Updates the parameters of the specified LbTrafficExtension resource. |
delete | delete | projectsId, locationsId, lbTrafficExtensionsId | requestId | Deletes 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.
| Name | Datatype | Description |
|---|---|---|
lbTrafficExtensionsId | string | |
locationsId | string | |
projectsId | string | |
filter | string | |
lbTrafficExtensionId | string | |
orderBy | string | |
pageSize | integer (int32) | |
pageToken | string | |
requestId | string | |
updateMask | string (google-fieldmask) |
SELECT examples
- get
- list
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
;
Lists LbTrafficExtension resources in a given project and location.
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 pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;
INSERT examples
- create
- Manifest
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
;
# Description fields are for documentation purposes
- name: lb_traffic_extensions
props:
- name: projectsId
value: string
description: Required parameter for the lb_traffic_extensions resource.
- name: locationsId
value: string
description: Required parameter for the lb_traffic_extensions resource.
- name: name
value: string
description: >
Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
- name: description
value: string
description: >
Optional. A human-readable description of the resource.
- name: labels
value: object
description: >
Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.
- name: forwardingRules
value: array
description: >
Optional. 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.
- name: extensionChains
value: array
description: >
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.
- name: loadBalancingScheme
value: string
description: >
Required. 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](https://cloud.google.com/load-balancing/docs/backend-service).
valid_values: ['LOAD_BALANCING_SCHEME_UNSPECIFIED', 'INTERNAL_MANAGED', 'EXTERNAL_MANAGED']
- name: metadata
value: object
description: >
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 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.
- name: lbTrafficExtensionId
value: string
- name: requestId
value: string
UPDATE examples
- patch
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
- delete
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 }}'
;