Grafeas V1 Client - Class ListNotesRequest (0.9.0)

Reference documentation and code samples for the Grafeas V1 Client class ListNotesRequest.

Request to list notes.

Generated from protobuf message grafeas.v1.ListNotesRequest

Namespace

Grafeas \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

The name of the project to list notes for in the form of projects/[PROJECT_ID].

↳ filter string

The filter expression.

↳ page_size int

Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

↳ page_token string

Token to provide to skip to a particular spot in the list.

getParent

The name of the project to list notes for in the form of projects/[PROJECT_ID].

Returns
TypeDescription
string

setParent

The name of the project to list notes for in the form of projects/[PROJECT_ID].

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

The filter expression.

Returns
TypeDescription
string

setFilter

The filter expression.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

Returns
TypeDescription
int

setPageSize

Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Token to provide to skip to a particular spot in the list.

Returns
TypeDescription
string

setPageToken

Token to provide to skip to a particular spot in the list.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

The name of the project to list notes for in the form of projects/[PROJECT_ID]. Please see Grafeas\V1\GrafeasClient::projectName() for help formatting this field.

filter string

The filter expression.

Returns
TypeDescription
Grafeas\V1\ListNotesRequest