extension_bindings

Creates, updates, deletes, gets or lists an extension_bindings resource.

Overview

Name	extension_bindings
Type	Resource
Id	google.networkservices.extension_bindings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Name of the ExtensionBinding resource in the following format: projects/{project}/locations/{location}/extensionBindings/{extension_binding}.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. A human-readable description of the resource.
etag	string	Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
failOpen	boolean	Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is FALSE. When set to TRUE, failures of the extension are silently ignored.
labels	object	Optional. Set of labels associated with the ExtensionBinding resource. The format must comply with the following requirements.
matchConditions	array	Optional. A list of match conditions to match against the incoming request. The extension will be invoked if at least one condition matches the request, or if no match conditions are specified. Limited to 5 conditions.
priority	integer (int32)	Optional. Priority of the extension binding. Lower numbers indicate higher priority. Priority of extension bindings are used to determine the order in which extension bindings are applied to a request.
producerExtension	string	Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint (see Model Armor integration)
producerMetadata	object	Optional. Additional metadata that should be passed to the attached extension with each request.
target	object	Required. Specifies a target to which this ExtensionBinding should be attached. The target can be either a single resource or a scope of resources. (id: ExtensionBindingTarget)
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

list

Name	Datatype	Description
name	string	Identifier. Name of the ExtensionBinding resource in the following format: projects/{project}/locations/{location}/extensionBindings/{extension_binding}.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. A human-readable description of the resource.
etag	string	Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
failOpen	boolean	Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is FALSE. When set to TRUE, failures of the extension are silently ignored.
labels	object	Optional. Set of labels associated with the ExtensionBinding resource. The format must comply with the following requirements.
matchConditions	array	Optional. A list of match conditions to match against the incoming request. The extension will be invoked if at least one condition matches the request, or if no match conditions are specified. Limited to 5 conditions.
priority	integer (int32)	Optional. Priority of the extension binding. Lower numbers indicate higher priority. Priority of extension bindings are used to determine the order in which extension bindings are applied to a request.
producerExtension	string	Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint (see Model Armor integration)
producerMetadata	object	Optional. Additional metadata that should be passed to the attached extension with each request.
target	object	Required. Specifies a target to which this ExtensionBinding should be attached. The target can be either a single resource or a scope of resources. (id: ExtensionBindingTarget)
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, extensionBindingsId		Gets details of the specified ExtensionBinding resource.
list	select	projectsId, locationsId	pageSize, pageToken	Lists ExtensionBinding resources in a given project and location.
create	insert	projectsId, locationsId	extensionBindingId	Creates a new ExtensionBinding resource in a given project and location.
patch	update	projectsId, locationsId, extensionBindingsId	updateMask	Updates the parameters of the specified ExtensionBinding resource.
delete	delete	projectsId, locationsId, extensionBindingsId	etag	Deletes the specified ExtensionBinding 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
extensionBindingsId	string
locationsId	string
projectsId	string
etag	string
extensionBindingId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of the specified ExtensionBinding resource.

SELECT
name,
createTime,
description,
etag,
failOpen,
labels,
matchConditions,
priority,
producerExtension,
producerMetadata,
target,
updateTime
FROM google.networkservices.extension_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND extensionBindingsId = '{{ extensionBindingsId }}' -- required
;

list

Lists ExtensionBinding resources in a given project and location.

SELECT
name,
createTime,
description,
etag,
failOpen,
labels,
matchConditions,
priority,
producerExtension,
producerMetadata,
target,
updateTime
FROM google.networkservices.extension_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

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

INSERT INTO google.networkservices.extension_bindings (
data__description,
data__etag,
data__failOpen,
data__labels,
data__matchConditions,
data__name,
data__priority,
data__producerExtension,
data__producerMetadata,
data__target,
projectsId,
locationsId,
extensionBindingId
)
SELECT 
'{{ description }}',
'{{ etag }}',
{{ failOpen }},
'{{ labels }}',
'{{ matchConditions }}',
'{{ name }}',
{{ priority }},
'{{ producerExtension }}',
'{{ producerMetadata }}',
'{{ target }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ extensionBindingId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: extension_bindings
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the extension_bindings resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the extension_bindings resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. A human-readable description of the resource.
  - name: etag
    value: "{{ etag }}"
    description: |
      Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
  - name: failOpen
    value: {{ failOpen }}
    description: |
      Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements).
  - name: matchConditions
    description: |
      Optional. A list of match conditions to match against the incoming request. The extension will be invoked if at least one condition matches the request, or if no match conditions are specified. Limited to 5 conditions.
    value:
      - to:
          destination:
            headerSet:
              headers:
                - name: "{{ name }}"
                  value:
                    contains: "{{ contains }}"
                    exact: "{{ exact }}"
                    ignoreCase: {{ ignoreCase }}
                    prefix: "{{ prefix }}"
                    suffix: "{{ suffix }}"
            hosts:
              - contains: "{{ contains }}"
                exact: "{{ exact }}"
                ignoreCase: {{ ignoreCase }}
                prefix: "{{ prefix }}"
                suffix: "{{ suffix }}"
            paths:
              - contains: "{{ contains }}"
                exact: "{{ exact }}"
                ignoreCase: {{ ignoreCase }}
                prefix: "{{ prefix }}"
                suffix: "{{ suffix }}"
            resources:
              - contains: "{{ contains }}"
                exact: "{{ exact }}"
                ignoreCase: {{ ignoreCase }}
                prefix: "{{ prefix }}"
                suffix: "{{ suffix }}"
          notDestination:
            headerSet:
              headers:
                - name: "{{ name }}"
                  value:
                    contains: "{{ contains }}"
                    exact: "{{ exact }}"
                    ignoreCase: {{ ignoreCase }}
                    prefix: "{{ prefix }}"
                    suffix: "{{ suffix }}"
            hosts:
              - contains: "{{ contains }}"
                exact: "{{ exact }}"
                ignoreCase: {{ ignoreCase }}
                prefix: "{{ prefix }}"
                suffix: "{{ suffix }}"
            paths:
              - contains: "{{ contains }}"
                exact: "{{ exact }}"
                ignoreCase: {{ ignoreCase }}
                prefix: "{{ prefix }}"
                suffix: "{{ suffix }}"
            resources:
              - contains: "{{ contains }}"
                exact: "{{ exact }}"
                ignoreCase: {{ ignoreCase }}
                prefix: "{{ prefix }}"
                suffix: "{{ suffix }}"
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.
  - name: priority
    value: {{ priority }}
    description: |
      Optional. Priority of the extension binding. Lower numbers indicate higher priority. Priority of extension bindings are used to determine the order in which extension bindings are applied to a request.
  - name: producerExtension
    value: "{{ producerExtension }}"
    description: |
      Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint (see [Model Armor integration](https://docs.cloud.google.com/model-armor/integrations))
  - name: producerMetadata
    value: "{{ producerMetadata }}"
    description: |
      Optional. Additional metadata that should be passed to the attached extension with each request.
  - name: target
    description: |
      Required. Specifies a target to which this `ExtensionBinding` should be attached. The target can be either a single resource or a scope of resources.
    value:
      resources:
        - "{{ resources }}"
      scope:
        parent: "{{ parent }}"
        resourceTypes:
          - "{{ resourceTypes }}"
  - name: extensionBindingId
    value: "{{ extensionBindingId }}"

UPDATE examples

patch

Updates the parameters of the specified ExtensionBinding resource.

UPDATE google.networkservices.extension_bindings
SET 
data__description = '{{ description }}',
data__etag = '{{ etag }}',
data__failOpen = {{ failOpen }},
data__labels = '{{ labels }}',
data__matchConditions = '{{ matchConditions }}',
data__name = '{{ name }}',
data__priority = {{ priority }},
data__producerExtension = '{{ producerExtension }}',
data__producerMetadata = '{{ producerMetadata }}',
data__target = '{{ target }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND extensionBindingsId = '{{ extensionBindingsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes the specified ExtensionBinding resource.

DELETE FROM google.networkservices.extension_bindings
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND extensionBindingsId = '{{ extensionBindingsId }}' --required
AND etag = '{{ etag }}'
;