Google Cloud Data Catalog V1 Client - Class ListEntriesRequest (1.4.2)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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_size is more than 1000.

↳ 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 name field, set read_mask to only one path with the name value.

getParent

Required. The name of the entry group that contains the entries to list.

Can be provided in URL format.

Returns
TypeDescription
string

setParent

Required. The name of the entry group that contains the entries to list.

Can be provided in URL format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of items to return. Default is 10. Maximum limit is

  1. Throws an invalid argument if page_size is more than 1000.
Returns
TypeDescription
int

setPageSize

The maximum number of items to return. Default is 10. Maximum limit is

  1. Throws an invalid argument if page_size is more than 1000.
Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Pagination token that specifies the next page to return. If empty, the first page is returned.

Returns
TypeDescription
string

setPageToken

Pagination token that specifies the next page to return. If empty, the first page is returned.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this