mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-04-09 03:02:26 -04:00
Merge branch 'main' into sample-testing-strategy-go-test
This commit is contained in:
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "alloydb-create-cluster"
|
||||
title: alloydb-create-cluster
|
||||
type: docs
|
||||
weight: 1
|
||||
description: >
|
||||
The "alloydb-create-cluster" tool creates a new AlloyDB for PostgreSQL cluster in a specified project and location.
|
||||
aliases:
|
||||
- /resources/tools/alloydb-create-cluster
|
||||
description: "The \"alloydb-create-cluster\" tool creates a new AlloyDB for PostgreSQL cluster in a specified project and location.\n"
|
||||
aliases: [/resources/tools/alloydb-create-cluster]
|
||||
---
|
||||
|
||||
## About
|
||||
@@ -15,20 +13,25 @@ This tool provisions a cluster with a **private IP address** within the specifie
|
||||
|
||||
**Permissions & APIs Required:**
|
||||
Before using, ensure the following on your GCP project:
|
||||
1. The [AlloyDB API](https://console.cloud.google.com/apis/library/alloydb.googleapis.com) is enabled.
|
||||
2. The user or service account executing the tool has the following IAM roles:
|
||||
- `roles/alloydb.admin`: To create and manage the AlloyDB cluster.
|
||||
|
||||
1. The [AlloyDB API](https://console.cloud.google.com/apis/library/alloydb.googleapis.com) is enabled.
|
||||
2. The user or service account executing the tool has one of the following IAM roles:
|
||||
|
||||
|
||||
- `roles/alloydb.admin` (the AlloyDB Admin predefined IAM role)
|
||||
- `roles/owner` (the Owner basic IAM role)
|
||||
- `roles/editor` (the Editor basic IAM role)
|
||||
|
||||
The tool takes the following input parameters:
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| `project` | string | The GCP project ID where the cluster will be created. | Yes |
|
||||
| `location` | string | The GCP location where the cluster will be created. Default: `us-central1`. If quota is exhausted then use other regions. | No |
|
||||
| `cluster` | string | A unique identifier for the new AlloyDB cluster. | Yes |
|
||||
| `password` | string | A secure password for the initial user. | Yes |
|
||||
| `network` | string | The name of the VPC network to connect the cluster to. Default: `default`. | No |
|
||||
| `user` | string | The name for the initial superuser. Default: `postgres`. | No |
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :------------------------------------------------------------------------------------------------------------------------ | :------- |
|
||||
| `project` | string | The GCP project ID where the cluster will be created. | Yes |
|
||||
| `cluster` | string | A unique identifier for the new AlloyDB cluster. | Yes |
|
||||
| `password` | string | A secure password for the initial user. | Yes |
|
||||
| `location` | string | The GCP location where the cluster will be created. Default: `us-central1`. If quota is exhausted then use other regions. | No |
|
||||
| `network` | string | The name of the VPC network to connect the cluster to. Default: `default`. | No |
|
||||
| `user` | string | The name for the initial superuser. Default: `postgres`. | No |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -39,9 +42,11 @@ tools:
|
||||
source: alloydb-admin-source
|
||||
description: Use this tool to create a new AlloyDB cluster in a given project and location.
|
||||
```
|
||||
|
||||
## Reference
|
||||
| **field** | **type** | **required** | **description** |
|
||||
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
||||
| kind | string | true | Must be alloydb-create-cluster. | |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
| **field** | **type** | **required** | **description** | |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- | - |
|
||||
| kind | string | true | Must be alloydb-create-cluster. | |
|
||||
| source | string | true | The name of an `alloydb-admin` source. | |
|
||||
| description | string | false | Description of the tool that is passed to the agent. | |
|
||||
|
||||
56
docs/en/resources/tools/alloydb/alloydb-create-instance.md
Normal file
56
docs/en/resources/tools/alloydb/alloydb-create-instance.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: alloydb-create-instance
|
||||
type: docs
|
||||
weight: 1
|
||||
description: "The \"alloydb-create-instance\" tool creates a new AlloyDB instance within a specified cluster.\n"
|
||||
aliases: [/resources/tools/alloydb-create-instance]
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
The `alloydb-create-instance` tool creates a new AlloyDB instance (PRIMARY or READ_POOL) within a specified cluster. It is compatible with [alloydb-admin](../../sources/alloydb-admin.md) source.
|
||||
This tool provisions a new instance with a **public IP address**.
|
||||
|
||||
**Permissions & APIs Required:**
|
||||
Before using, ensure the following on your GCP project:
|
||||
|
||||
1. The [AlloyDB API](https://console.cloud.google.com/apis/library/alloydb.googleapis.com) is enabled.
|
||||
2. The user or service account executing the tool has one of the following IAM roles:
|
||||
|
||||
|
||||
- `roles/alloydb.admin` (the AlloyDB Admin predefined IAM role)
|
||||
- `roles/owner` (the Owner basic IAM role)
|
||||
- `roles/editor` (the Editor basic IAM role)
|
||||
|
||||
The tool takes the following input parameters:
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :------------- | :----- | :------------------------------------------------------------------------------------------------ | :------- |
|
||||
| `project` | string | The GCP project ID where the cluster exists. | Yes |
|
||||
| `location` | string | The GCP location where the cluster exists (e.g., `us-central1`). | Yes |
|
||||
| `cluster` | string | The ID of the existing cluster to add this instance to. | Yes |
|
||||
| `instance` | string | A unique identifier for the new AlloyDB instance. | Yes |
|
||||
| `instanceType` | string | The type of instance. Valid values are: `PRIMARY` and `READ_POOL`. Default: `PRIMARY` | No |
|
||||
| `displayName` | string | An optional, user-friendly name for the instance. | No |
|
||||
| `nodeCount` | int | The number of nodes for a read pool. Required only if `instanceType` is `READ_POOL`. Default: `1` | No |
|
||||
|
||||
> Note
|
||||
> The tool sets the `password.enforce_complexity` database flag to `on`, requiring new database passwords to meet complexity rules.
|
||||
|
||||
## Example
|
||||
|
||||
```yaml
|
||||
tools:
|
||||
create_instance:
|
||||
kind: alloydb-create-instance
|
||||
source: alloydb-admin-source
|
||||
description: Use this tool to create a new AlloyDB instance within a specified cluster.
|
||||
```
|
||||
|
||||
## Reference
|
||||
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- |
|
||||
| kind | string | true | Must be alloydb-create-instance. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "alloydb-create-user"
|
||||
title: alloydb-create-user
|
||||
type: docs
|
||||
weight: 2
|
||||
description: >
|
||||
The "alloydb-create-user" tool creates a new database user within a specified AlloyDB cluster.
|
||||
aliases:
|
||||
- /resources/tools/alloydb-create-user
|
||||
weight: 2
|
||||
description: "The \"alloydb-create-user\" tool creates a new database user within a specified AlloyDB cluster.\n"
|
||||
aliases: [/resources/tools/alloydb-create-user]
|
||||
---
|
||||
|
||||
## About
|
||||
@@ -14,21 +12,24 @@ The `alloydb-create-user` tool creates a new database user (`ALLOYDB_BUILT_IN` o
|
||||
|
||||
**Permissions & APIs Required:**
|
||||
Before using, ensure the following on your GCP project:
|
||||
|
||||
1. The [AlloyDB API](https://console.cloud.google.com/apis/library/alloydb.googleapis.com) is enabled.
|
||||
2. The user or service account executing the tool has the following IAM roles:
|
||||
- `roles/alloydb.admin`: To create and manage AlloyDB users.
|
||||
2. The user or service account executing the tool has one of the following IAM roles:
|
||||
- `roles/alloydb.admin` (the AlloyDB Admin predefined IAM role)
|
||||
- `roles/owner` (the Owner basic IAM role)
|
||||
- `roles/editor` (the Editor basic IAM role)
|
||||
|
||||
The tool takes the following input parameters:
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| `project` | string | The GCP project ID where the cluster exists. | Yes |
|
||||
| `cluster` | string | The ID of the existing cluster where the user will be created. | Yes |
|
||||
| `location` | string | The GCP location where the cluster exists (e.g., `us-central1`). | Yes |
|
||||
| `user` | string | The name for the new user. Must be unique within the cluster. | Yes |
|
||||
| `userType` | string | The type of user. Valid values: `ALLOYDB_BUILT_IN` and `ALLOYDB_IAM_USER`. `ALLOYDB_IAM_USER` is recommended. | Yes |
|
||||
| `password` | string | A secure password for the user. Required only if `userType` is `ALLOYDB_BUILT_IN`. | No |
|
||||
| `databaseRoles` | array(string) | Optional. A list of database roles to grant to the new user (e.g., `pg_read_all_data`). | No |
|
||||
| Parameter | Type | Description | Required |
|
||||
| :-------------- | :------------ | :------------------------------------------------------------------------------------------------------------ | :------- |
|
||||
| `project` | string | The GCP project ID where the cluster exists. | Yes |
|
||||
| `cluster` | string | The ID of the existing cluster where the user will be created. | Yes |
|
||||
| `location` | string | The GCP location where the cluster exists (e.g., `us-central1`). | Yes |
|
||||
| `user` | string | The name for the new user. Must be unique within the cluster. | Yes |
|
||||
| `userType` | string | The type of user. Valid values: `ALLOYDB_BUILT_IN` and `ALLOYDB_IAM_USER`. `ALLOYDB_IAM_USER` is recommended. | Yes |
|
||||
| `password` | string | A secure password for the user. Required only if `userType` is `ALLOYDB_BUILT_IN`. | No |
|
||||
| `databaseRoles` | array(string) | Optional. A list of database roles to grant to the new user (e.g., `pg_read_all_data`). | No |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -39,9 +40,11 @@ tools:
|
||||
source: alloydb-admin-source
|
||||
description: Use this tool to create a new database user for an AlloyDB cluster.
|
||||
```
|
||||
|
||||
## Reference
|
||||
| **field** | **type** | **required** | **description** |
|
||||
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
||||
| kind | string | true | Must be alloydb-create-user. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- |
|
||||
| kind | string | true | Must be alloydb-create-user. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
@@ -1,22 +1,20 @@
|
||||
---
|
||||
title: "alloydb-get-cluster"
|
||||
title: alloydb-get-cluster
|
||||
type: docs
|
||||
weight: 1
|
||||
description: >
|
||||
The "alloydb-get-cluster" tool retrieves details for a specific AlloyDB cluster.
|
||||
aliases:
|
||||
- /resources/tools/alloydb-get-cluster
|
||||
description: "The \"alloydb-get-cluster\" tool retrieves details for a specific AlloyDB cluster.\n"
|
||||
aliases: [/resources/tools/alloydb-get-cluster]
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
The `alloydb-get-cluster` tool retrieves detailed information for a single, specified AlloyDB cluster. It is compatible with [alloydb-admin](../../sources/alloydb-admin.md) source.
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :--------------------------------------------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to get cluster for. | Yes |
|
||||
| `location` | string | The location of the cluster (e.g., 'us-central1'). | Yes |
|
||||
| `cluster` | string | The ID of the cluster to retrieve. | Yes |
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to get cluster for. | Yes |
|
||||
| `location` | string | The location of the cluster (e.g., 'us-central1'). | Yes |
|
||||
| `cluster` | string | The ID of the cluster to retrieve. | Yes |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -27,9 +25,11 @@ tools:
|
||||
source: my-alloydb-admin-source
|
||||
description: Use this tool to retrieve details for a specific AlloyDB cluster.
|
||||
```
|
||||
|
||||
## Reference
|
||||
| **field** | **type** | **required** | **description** |
|
||||
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
||||
| kind | string | true | Must be alloydb-get-cluster. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- |
|
||||
| kind | string | true | Must be alloydb-get-cluster. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
@@ -1,23 +1,21 @@
|
||||
---
|
||||
title: "alloydb-get-instance"
|
||||
title: alloydb-get-instance
|
||||
type: docs
|
||||
weight: 1
|
||||
description: >
|
||||
The "alloydb-get-instance" tool retrieves details for a specific AlloyDB instance.
|
||||
aliases:
|
||||
- /resources/tools/alloydb-get-instance
|
||||
description: "The \"alloydb-get-instance\" tool retrieves details for a specific AlloyDB instance.\n"
|
||||
aliases: [/resources/tools/alloydb-get-instance]
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
The `alloydb-get-instance` tool retrieves detailed information for a single, specified AlloyDB instance. It is compatible with [alloydb-admin](../../sources/alloydb-admin.md) source.
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :--------------------------------------------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to get instance for. | Yes |
|
||||
| `location` | string | The location of the instance (e.g., 'us-central1'). | Yes |
|
||||
| `cluster` | string | The ID of the cluster. | Yes |
|
||||
| `instance` | string | The ID of the instance to retrieve. | Yes |
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :-------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to get instance for. | Yes |
|
||||
| `location` | string | The location of the instance (e.g., 'us-central1'). | Yes |
|
||||
| `cluster` | string | The ID of the cluster. | Yes |
|
||||
| `instance` | string | The ID of the instance to retrieve. | Yes |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -28,9 +26,11 @@ tools:
|
||||
source: my-alloydb-admin-source
|
||||
description: Use this tool to retrieve details for a specific AlloyDB instance.
|
||||
```
|
||||
|
||||
## Reference
|
||||
| **field** | **type** | **required** | **description** |
|
||||
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
||||
| kind | string | true | Must be alloydb-get-instance. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- |
|
||||
| kind | string | true | Must be alloydb-get-instance. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
@@ -1,23 +1,21 @@
|
||||
---
|
||||
title: "alloydb-get-user"
|
||||
title: alloydb-get-user
|
||||
type: docs
|
||||
weight: 1
|
||||
description: >
|
||||
The "alloydb-get-user" tool retrieves details for a specific AlloyDB user.
|
||||
aliases:
|
||||
- /resources/tools/alloydb-get-user
|
||||
description: "The \"alloydb-get-user\" tool retrieves details for a specific AlloyDB user.\n"
|
||||
aliases: [/resources/tools/alloydb-get-user]
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
The `alloydb-get-user` tool retrieves detailed information for a single, specified AlloyDB user. It is compatible with [alloydb-admin](../../sources/alloydb-admin.md) source.
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :--------------------------------------------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to get user for. | Yes |
|
||||
| `location` | string | The location of the cluster (e.g., 'us-central1'). | Yes |
|
||||
| `cluster` | string | The ID of the cluster to retrieve the user from. | Yes |
|
||||
| `user` | string | The ID of the user to retrieve. | Yes |
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to get user for. | Yes |
|
||||
| `location` | string | The location of the cluster (e.g., 'us-central1'). | Yes |
|
||||
| `cluster` | string | The ID of the cluster to retrieve the user from. | Yes |
|
||||
| `user` | string | The ID of the user to retrieve. | Yes |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -28,9 +26,11 @@ tools:
|
||||
source: my-alloydb-admin-source
|
||||
description: Use this tool to retrieve details for a specific AlloyDB user.
|
||||
```
|
||||
|
||||
## Reference
|
||||
| **field** | **type** | **required** | **description** |
|
||||
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
||||
| kind | string | true | Must be alloydb-get-user. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- |
|
||||
| kind | string | true | Must be alloydb-get-user. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "alloydb-list-clusters"
|
||||
title: alloydb-list-clusters
|
||||
type: docs
|
||||
weight: 1
|
||||
description: >
|
||||
The "alloydb-list-clusters" tool lists the AlloyDB clusters in a given project and location.
|
||||
aliases:
|
||||
- /resources/tools/alloydb-list-clusters
|
||||
description: "The \"alloydb-list-clusters\" tool lists the AlloyDB clusters in a given project and location.\n"
|
||||
aliases: [/resources/tools/alloydb-list-clusters]
|
||||
---
|
||||
|
||||
## About
|
||||
@@ -13,7 +11,7 @@ aliases:
|
||||
The `alloydb-list-clusters` tool retrieves AlloyDB cluster information for all or specified locations in a given project. It is compatible with [alloydb-admin](../../sources/alloydb-admin.md) source.
|
||||
|
||||
`alloydb-list-clusters` tool lists the detailed information of AlloyDB cluster(cluster name, state, configuration, etc) for a given project and location. The tool takes the following input parameters:
|
||||
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :----------------------------------------------------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to list clusters for. | Yes |
|
||||
@@ -28,9 +26,11 @@ tools:
|
||||
source: alloydb-admin-source
|
||||
description: Use this tool to list all AlloyDB clusters in a given project and location.
|
||||
```
|
||||
|
||||
## Reference
|
||||
| **field** | **type** | **required** | **description** |
|
||||
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
||||
| kind | string | true | Must be alloydb-list-clusters. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- |
|
||||
| kind | string | true | Must be alloydb-list-clusters. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "alloydb-list-instances"
|
||||
title: alloydb-list-instances
|
||||
type: docs
|
||||
weight: 1
|
||||
description: >
|
||||
The "alloydb-list-instances" tool lists the AlloyDB instances for a given project, cluster and location.
|
||||
aliases:
|
||||
- /resources/tools/alloydb-list-instances
|
||||
description: "The \"alloydb-list-instances\" tool lists the AlloyDB instances for a given project, cluster and location.\n"
|
||||
aliases: [/resources/tools/alloydb-list-instances]
|
||||
---
|
||||
|
||||
## About
|
||||
@@ -13,7 +11,7 @@ aliases:
|
||||
The `alloydb-list-instances` tool retrieves AlloyDB instance information for all or specified clusters and locations in a given project. It is compatible with [alloydb-admin](../../sources/alloydb-admin.md) source.
|
||||
|
||||
`alloydb-list-instances` tool lists the detailed information of AlloyDB instances (instance name, type, IP address, state, configuration, etc) for a given project, cluster and location. The tool takes the following input parameters:
|
||||
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :--------------------------------------------------------------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to list instances for. | Yes |
|
||||
@@ -29,9 +27,11 @@ tools:
|
||||
source: alloydb-admin-source
|
||||
description: Use this tool to list all AlloyDB instances for a given project, cluster and location.
|
||||
```
|
||||
|
||||
## Reference
|
||||
| **field** | **type** | **required** | **description** |
|
||||
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
||||
| kind | string | true | Must be alloydb-list-instances. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- |
|
||||
| kind | string | true | Must be alloydb-list-instances. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
@@ -1,23 +1,21 @@
|
||||
---
|
||||
title: "alloydb-list-users"
|
||||
title: alloydb-list-users
|
||||
type: docs
|
||||
weight: 1
|
||||
description: >
|
||||
The "alloydb-list-users" tool lists all database users within an AlloyDB cluster.
|
||||
aliases:
|
||||
- /resources/tools/alloydb-list-users
|
||||
description: "The \"alloydb-list-users\" tool lists all database users within an AlloyDB cluster.\n"
|
||||
aliases: [/resources/tools/alloydb-list-users]
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
The `alloydb-list-users` tool lists all database users within an AlloyDB cluster. It is compatible with [alloydb-admin](../../sources/alloydb-admin.md) source.
|
||||
The tool takes the following input parameters:
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :--------------------------------------------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to list users for. | Yes |
|
||||
| `cluster` | string | The ID of the cluster to list users from. | Yes |
|
||||
| `location` | string | The location of the cluster (e.g., 'us-central1'). | Yes |
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID to list users for. | Yes |
|
||||
| `cluster` | string | The ID of the cluster to list users from. | Yes |
|
||||
| `location` | string | The location of the cluster (e.g., 'us-central1'). | Yes |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -28,9 +26,11 @@ tools:
|
||||
source: alloydb-admin-source
|
||||
description: Use this tool to list all database users within an AlloyDB cluster
|
||||
```
|
||||
|
||||
## Reference
|
||||
| **field** | **type** | **required** | **description** |
|
||||
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
||||
| kind | string | true | Must be alloydb-list-users. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------- |
|
||||
| kind | string | true | Must be alloydb-list-users. |
|
||||
| source | string | true | The name of an `alloydb-admin` source. |
|
||||
| description | string | false | Description of the tool that is passed to the agent. |
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
---
|
||||
title: "alloydb-wait-for-operation"
|
||||
title: alloydb-wait-for-operation
|
||||
type: docs
|
||||
weight: 10
|
||||
description: >
|
||||
Wait for a long-running AlloyDB operation to complete.
|
||||
description: "Wait for a long-running AlloyDB operation to complete.\n"
|
||||
---
|
||||
|
||||
The `alloydb-wait-for-operation` tool is a utility tool that waits for a
|
||||
@@ -11,11 +10,11 @@ long-running AlloyDB operation to complete. It does this by polling the AlloyDB
|
||||
Admin API operation status endpoint until the operation is finished, using
|
||||
exponential backoff. It is compatible with [alloydb-admin](../../sources/alloydb-admin.md) source.
|
||||
|
||||
| Parameter | Type | Description | Required |
|
||||
| :--------- | :----- | :--------------------------------------------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID. | Yes |
|
||||
| `location` | string | The location of the operation (e.g., 'us-central1'). | Yes |
|
||||
| `operation`| string | The ID of the operation to wait for. | Yes |
|
||||
| Parameter | Type | Description | Required |
|
||||
| :---------- | :----- | :--------------------------------------------------- | :------- |
|
||||
| `project` | string | The GCP project ID. | Yes |
|
||||
| `location` | string | The location of the operation (e.g., 'us-central1'). | Yes |
|
||||
| `operation` | string | The ID of the operation to wait for. | Yes |
|
||||
|
||||
{{< notice info >}}
|
||||
This tool is intended for developer assistant workflows with human-in-the-loop
|
||||
@@ -41,9 +40,9 @@ tools:
|
||||
| **field** | **type** | **required** | **description** |
|
||||
| ----------- | :------: | :----------: | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| kind | string | true | Must be "alloydb-wait-for-operation". |
|
||||
| source | string | true | The name of a `alloydb-admin` source to use for authentication. |
|
||||
| description | string | false | A description of the tool. |
|
||||
| delay | duration | false | The initial delay between polling requests (e.g., `3s`). Defaults to 3 seconds. |
|
||||
| maxDelay | duration | false | The maximum delay between polling requests (e.g., `4m`). Defaults to 4 minutes. |
|
||||
| multiplier | float | false | The multiplier for the polling delay. The delay is multiplied by this value after each request. Defaults to 2.0. |
|
||||
| maxRetries | int | false | The maximum number of polling attempts before giving up. Defaults to 10. |
|
||||
| source | string | true | The name of a `alloydb-admin` source to use for authentication. |
|
||||
| description | string | false | A description of the tool. |
|
||||
| delay | duration | false | The initial delay between polling requests (e.g., `3s`). Defaults to 3 seconds. |
|
||||
| maxDelay | duration | false | The maximum delay between polling requests (e.g., `4m`). Defaults to 4 minutes. |
|
||||
| multiplier | float | false | The multiplier for the polling delay. The delay is multiplied by this value after each request. Defaults to 2.0. |
|
||||
| maxRetries | int | false | The maximum number of polling attempts before giving up. Defaults to 10. |
|
||||
|
||||
Reference in New Issue
Block a user