Google Cloud Dataplex V1 Client - Class ListEntitiesRequest (0.7.0)

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`

setView

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

Parameter
Name	Description
`var`	`int`

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

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

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 Google\Cloud\Dataplex\V1\MetadataServiceClient::zoneName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\ListEntitiesRequest`