Reference documentation and code samples for the Grafeas V1 Client class ListOccurrencesRequest.
Request to list occurrences.
Generated from protobuf message grafeas.v1.ListOccurrencesRequest
Namespace
Grafeas \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
The name of the project to list occurrences for in the form of |
↳ filter |
string
The filter expression. |
↳ page_size |
int
Number of occurrences 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. |
↳ return_partial_success |
bool
If set, the request will return all reachable Occurrences and report all unreachable regions in the |
getParent
The name of the project to list occurrences for in the form of
projects/[PROJECT_ID].
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
The name of the project to list occurrences for in the form of
projects/[PROJECT_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. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
| 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 |
|
getReturnPartialSuccess
If set, the request will return all reachable Occurrences
and report all unreachable regions in the unreachable field in
the response.
Only applicable for requests in the global region.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReturnPartialSuccess
If set, the request will return all reachable Occurrences
and report all unreachable regions in the unreachable field in
the response.
Only applicable for requests in the global region.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
The name of the project to list occurrences for in the form of
|
filter |
string
The filter expression. |
| Returns | |
|---|---|
| Type | Description |
ListOccurrencesRequest |
|