0.16.0 (latest) 0.15.0 0.14.1 0.11.1 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.1

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class ListDataAgentsRequest.

Message for requesting list of DataAgents.

Generated from protobuf message `google.cloud.geminidataanalytics.v1beta.ListDataAgentsRequest`

## Namespace

Google \\ Cloud \\ GeminiDataAnalytics \\ V1beta

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. Parent value for ListDataAgentsRequest. |
| `↳ page_size` | `int` Optional. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `↳ page_token` | `string` Optional. A page token, received from a previous `ListDataAgents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataAgents` must match the call that provided the page token. The service may return fewer than this value. |
| `↳ filter` | `string` Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for syntax. |
| `↳ order_by` | `string` Optional. User specification for how to order the results. |
| `↳ show_deleted` | `bool` Optional. If true, the list results will include soft-deleted DataAgents. Defaults to false. |
| `↳ creator_filter` | `int` Optional. Filter for the creator of the agent. |

### getParent

Required. Parent value for ListDataAgentsRequest.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setParent

Required. Parent value for ListDataAgentsRequest.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageSize

Optional. Server may return fewer items than requested.

If unspecified, server will pick an appropriate default.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setPageSize

Optional. Server may return fewer items than requested.

If unspecified, server will pick an appropriate default.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageToken

Optional. A page token, received from a previous `ListDataAgents` call.

Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to `ListDataAgents` must
match the call that provided the page token. The service may return fewer
than this value.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPageToken

Optional. A page token, received from a previous `ListDataAgents` call.

Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to `ListDataAgents` must
match the call that provided the page token. The service may return fewer
than this value.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getFilter

Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for
syntax.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setFilter

Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for
syntax.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOrderBy

Optional. User specification for how to order the results.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setOrderBy

Optional. User specification for how to order the results.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getShowDeleted

Optional. If true, the list results will include soft-deleted DataAgents.

Defaults to false.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setShowDeleted

Optional. If true, the list results will include soft-deleted DataAgents.

Defaults to false.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCreatorFilter

Optional. Filter for the creator of the agent.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [CreatorFilter](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.ListAccessibleDataAgentsRequest.CreatorFilter). |

### setCreatorFilter

Optional. Filter for the creator of the agent.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [CreatorFilter](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.ListAccessibleDataAgentsRequest.CreatorFilter). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. Parent value for ListDataAgentsRequest. Please see DataAgentServiceClient::locationName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.ListDataAgentsRequest` |   |