Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class ListEntriesRequest.
Request message for ListEntries.
Generated from protobuf message google.cloud.datacatalog.v1.ListEntriesRequest
Namespace
Google \ Cloud \ DataCatalog \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The name of the entry group that contains the entries to list. Can be provided in URL format. |
↳ page_size |
int
The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if |
↳ page_token |
string
Pagination token that specifies the next page to return. If empty, the first page is returned. |
↳ read_mask |
Google\Protobuf\FieldMask
The fields to return for each entry. If empty or omitted, all fields are returned. For example, to return a list of entries with only the |
getParent
Required. The name of the entry group that contains the entries to list.
Can be provided in URL format.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The name of the entry group that contains the entries to list.
Can be provided in URL format.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
The maximum number of items to return. Default is 10. Maximum limit is
- Throws an invalid argument if
page_size
is more than 1000.
Returns | |
---|---|
Type | Description |
int |
setPageSize
The maximum number of items to return. Default is 10. Maximum limit is
- Throws an invalid argument if
page_size
is more than 1000.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Pagination token that specifies the next page to return. If empty, the first page is returned.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Pagination token that specifies the next page to return. If empty, the first page is returned.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReadMask
The fields to return for each entry. If empty or omitted, all fields are returned.
For example, to return a list of entries with only the name
field,
set read_mask
to only one path with the name
value.
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasReadMask
clearReadMask
setReadMask
The fields to return for each entry. If empty or omitted, all fields are returned.
For example, to return a list of entries with only the name
field,
set read_mask
to only one path with the name
value.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. The name of the entry group that contains the entries to list. Can be provided in URL format. Please see Google\Cloud\DataCatalog\V1\DataCatalogClient::entryGroupName() for help formatting this field. |
Returns | |
---|---|
Type | Description |
Google\Cloud\DataCatalog\V1\ListEntriesRequest |