Google Cloud Dataplex V1 Client - Class ListEntriesRequest (1.1.0)

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

List Entries request.

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

Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.
↳ page_token string

Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.
↳ filter string

Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: * * entry_type * * entry_source.display_name The comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order. You can use the logical operators AND, OR, NOT in the filter. You can use Wildcard "", but for entry_type you need to provide the full project id or number. 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

Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.

Returns
Type Description
int

setPageSize

Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.

Returns
Type Description
string

setPageToken

Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. A filter on the entries to return. Filters are case-sensitive.

You can filter the request by the following fields:

  • entry_type
  • entry_source.display_name The comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order. You can use the logical operators AND, OR, NOT in the filter. You can use Wildcard "*", but for entry_type you need to provide the full project id or number. 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. Filters are case-sensitive.

You can filter the request by the following fields:

  • entry_type
  • entry_source.display_name The comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order. You can use the logical operators AND, OR, NOT in the filter. You can use Wildcard "*", but for entry_type you need to provide the full project id or number. 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"
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 CatalogServiceClient::entryGroupName() for help formatting this field.
Returns
Type Description
ListEntriesRequest