Google Cloud Dataplex V1 Client - Class ListEntriesRequest (0.16.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEntriesRequest.

Generated from protobuf message google.cloud.dataplex.v1.ListEntriesRequest

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 Entry Group: `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
`↳ page_size`	`int`
`↳ page_token`	`string` Optional. The pagination token returned by a previous request.
`↳ filter`	`string` Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, entry_source.display_name. The comparison operators are =, !=, <, >, <=, >= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Wildcard "" can be used, but for entry_type the full project id or number needs to be provided. Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a OR entry_type=projects/another-project/locations/*" "NOT entry_source.display_name=AnotherExampleDisplayName"

getParent

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.

Returns
Type	Description
`string`

setParent

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

setPageSize

Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. The pagination token returned by a previous request.

Returns
Type	Description
`string`

setPageToken

Optional. The pagination token returned by a previous request.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. A filter on the entries to return.

Filters are case-sensitive. The request can be filtered by the following fields: entry_type, entry_source.display_name. The comparison operators are =, !=, <, >, <=, >= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Wildcard "" can be used, but for entry_type the full project id or number needs to be provided. Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a OR entry_type=projects/another-project/locations/*" "NOT entry_source.display_name=AnotherExampleDisplayName"

Returns
Type	Description
`string`

setFilter

Optional. A filter on the entries to return.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The resource name of the parent Entry Group: `projects/{project}/locations/{location}/entryGroups/{entry_group}`. Please see Google\Cloud\Dataplex\V1\CatalogServiceClient::entryGroupName() for help formatting this field.

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