bindings
Creates, updates, deletes, gets or lists a bindings resource.
Overview
| Name | bindings |
| Type | Resource |
| Id | google.agentregistry.bindings |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
name | string | Required. Identifier. The resource name of the Binding. Format: projects/{project}/locations/{location}/bindings/{binding}. |
authProviderBinding | object | The binding for AuthProvider. (id: AuthProviderBinding) |
createTime | string (google-datetime) | Output only. Timestamp when this binding was created. |
description | string | Optional. User-defined description of a Binding. Can have a maximum length of 2048 characters. |
displayName | string | Optional. User-defined display name for the Binding. Can have a maximum length of 63 characters. |
source | object | Required. The target Agent of the Binding. (id: Source) |
target | object | Required. The target Agent Registry Resource of the Binding. (id: Target) |
updateTime | string (google-datetime) | Output only. Timestamp when this binding was last updated. |
| Name | Datatype | Description |
|---|---|---|
name | string | Required. Identifier. The resource name of the Binding. Format: projects/{project}/locations/{location}/bindings/{binding}. |
authProviderBinding | object | The binding for AuthProvider. (id: AuthProviderBinding) |
createTime | string (google-datetime) | Output only. Timestamp when this binding was created. |
description | string | Optional. User-defined description of a Binding. Can have a maximum length of 2048 characters. |
displayName | string | Optional. User-defined display name for the Binding. Can have a maximum length of 63 characters. |
source | object | Required. The target Agent of the Binding. (id: Source) |
target | object | Required. The target Agent Registry Resource of the Binding. (id: Target) |
updateTime | string (google-datetime) | Output only. Timestamp when this binding was last updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | projectsId, locationsId, bindingsId | Gets details of a single Binding. | |
list | select | projectsId, locationsId | filter, pageToken, orderBy, pageSize | Lists Bindings in a given project and location. |
create | insert | projectsId, locationsId | requestId, bindingId | Creates a new Binding in a given project and location. |
patch | update | projectsId, locationsId, bindingsId | updateMask, requestId | Updates the parameters of a single Binding. |
delete | delete | projectsId, locationsId, bindingsId | requestId | Deletes a single Binding. |
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 |
|---|---|---|
bindingsId | string | |
locationsId | string | |
projectsId | string | |
bindingId | string | |
filter | string | |
orderBy | string | |
pageSize | integer (int32) | |
pageToken | string | |
requestId | string | |
updateMask | string (google-fieldmask) |
SELECT examples
- get
- list
Gets details of a single Binding.
SELECT
name,
authProviderBinding,
createTime,
description,
displayName,
source,
target,
updateTime
FROM google.agentregistry.bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bindingsId = '{{ bindingsId }}' -- required
;
Lists Bindings in a given project and location.
SELECT
name,
authProviderBinding,
createTime,
description,
displayName,
source,
target,
updateTime
FROM google.agentregistry.bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
;
INSERT examples
- create
- Manifest
Creates a new Binding in a given project and location.
INSERT INTO google.agentregistry.bindings (
data__authProviderBinding,
data__name,
data__displayName,
data__source,
data__target,
data__description,
projectsId,
locationsId,
requestId,
bindingId
)
SELECT
'{{ authProviderBinding }}',
'{{ name }}',
'{{ displayName }}',
'{{ source }}',
'{{ target }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}',
'{{ bindingId }}'
RETURNING
name,
done,
error,
metadata,
response
;
# Description fields are for documentation purposes
- name: bindings
props:
- name: projectsId
value: "{{ projectsId }}"
description: Required parameter for the bindings resource.
- name: locationsId
value: "{{ locationsId }}"
description: Required parameter for the bindings resource.
- name: authProviderBinding
description: |
The binding for AuthProvider.
value:
continueUri: "{{ continueUri }}"
scopes:
- "{{ scopes }}"
authProvider: "{{ authProvider }}"
- name: name
value: "{{ name }}"
description: |
Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
- name: displayName
value: "{{ displayName }}"
description: |
Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
- name: source
description: |
Required. The target Agent of the Binding.
value:
identifier: "{{ identifier }}"
- name: target
description: |
Required. The target Agent Registry Resource of the Binding.
value:
identifier: "{{ identifier }}"
- name: description
value: "{{ description }}"
description: |
Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
- name: requestId
value: "{{ requestId }}"
- name: bindingId
value: "{{ bindingId }}"
UPDATE examples
- patch
Updates the parameters of a single Binding.
UPDATE google.agentregistry.bindings
SET
data__authProviderBinding = '{{ authProviderBinding }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__source = '{{ source }}',
data__target = '{{ target }}',
data__description = '{{ description }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bindingsId = '{{ bindingsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;
DELETE examples
- delete
Deletes a single Binding.
DELETE FROM google.agentregistry.bindings
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bindingsId = '{{ bindingsId }}' --required
AND requestId = '{{ requestId }}'
;