# Google Cloud Dataplex V1 Client - Class ListEntitiesRequest (1.14.0)

1.14.0 (latest) 1.13.0 1.12.0 1.11.0 1.10.0 1.9.1 1.8.0 1.7.1 1.6.1 1.4.0 1.3.0 1.2.1 1.1.1 1.0.1 0.16.1 0.15.1 0.14.0 0.13.0 0.12.0 0.11.1 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.1 0.4.0 0.3.0 0.2.3 0.1.6 Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEntitiesRequest.

List metadata entities request.

Generated from protobuf message `google.cloud.dataplex.v1.ListEntitiesRequest`

## Namespace

Google \\ Cloud \\ Dataplex \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. |
| `↳ view` | `int` Required. Specify the entity view to make a partial list request. |
| `↳ page_size` | `int` Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500. |
| `↳ page_token` | `string` Optional. Page token received from a previous `ListEntities` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEntities` must match the call that provided the page token. |
| `↳ filter` | `string` Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: - Entity ID: ?filter="id=entityID" - Asset ID: ?filter="asset=assetID" - Data path ?filter="data_path=gs://my-bucket" - Is HIVE compatible: ?filter="hive_compatible=true" - Is BigQuery compatible: ?filter="bigquery_compatible=true" |

### getParent

Required. The resource name of the parent zone:
`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

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

### setParent

Required. The resource name of the parent zone:
`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

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

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

### getView

Required. Specify the entity view to make a partial list request.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [EntityView](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.ListEntitiesRequest.EntityView). |

### setView

Required. Specify the entity view to make a partial list request.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [EntityView](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.ListEntitiesRequest.EntityView). |

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

### getPageSize

Optional. Maximum number of entities to return. The service may return
fewer than this value. If unspecified, 100 entities will be returned by
default. The maximum value is 500; larger values will will be truncated to
500.

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

### setPageSize

Optional. Maximum number of entities to return. The service may return
fewer than this value. If unspecified, 100 entities will be returned by
default. The maximum value is 500; larger values will will be truncated to
500.

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

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

### getPageToken

Optional. Page token received from a previous `ListEntities` call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to `ListEntities` must match the call that provided the
page token.

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

### setPageToken

Optional. Page token received from a previous `ListEntities` call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to `ListEntities` must match the call that provided the
page token.

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

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

### getFilter

Optional. The following filter parameters can be added to the URL to limit
the entities returned by the API:

- Entity ID: ?filter="id=entityID"
- Asset ID: ?filter="asset=assetID"
- Data path ?filter="data_path=gs://my-bucket"
- Is HIVE compatible: ?filter="hive_compatible=true"
- Is BigQuery compatible: ?filter="bigquery_compatible=true"

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

### setFilter

Optional. The following filter parameters can be added to the URL to limit
the entities returned by the API:

- Entity ID: ?filter="id=entityID"
- Asset ID: ?filter="asset=assetID"
- Data path ?filter="data_path=gs://my-bucket"
- Is HIVE compatible: ?filter="hive_compatible=true"
- Is BigQuery compatible: ?filter="bigquery_compatible=true"

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

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. Please see MetadataServiceClient::zoneName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.ListEntitiesRequest` |   |