Grafeas V1 Client - Class ListNoteOccurrencesRequest (1.3.1)

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

Request to list occurrences for a note.

Generated from protobuf message grafeas.v1.ListNoteOccurrencesRequest

Namespace

Grafeas \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
↳ filter string

The filter expression.
↳ page_size int

Number of occurrences to return in the list.
↳ page_token string

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

getName

The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

Returns
Type Description
string

setName

The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

The filter expression.

Returns
Type Description
string

setFilter

The filter expression.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Number of occurrences to return in the list.

Returns
Type Description
int

setPageSize

Number of occurrences to return in the list.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

Returns
Type Description
string

setPageToken

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID]. Please see GrafeasClient::noteName() for help formatting this field.
filter string

The filter expression.
Returns
Type Description
ListNoteOccurrencesRequest