Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class ListCorporaRequest.
Request message for ListCorpora.
Generated from protobuf message google.cloud.visionai.v1.ListCorporaRequest
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the project from which to list corpora. |
↳ page_size |
int
Requested page size. API may return fewer results than requested. If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick use the maximum size, which is 20. |
↳ page_token |
string
A token identifying a page of results for the server to return. Typically obtained via ListCorporaResponse.next_page_token of the previous Warehouse.ListCorpora call. |
↳ filter |
string
The filter applied to the returned corpora list. Only the following restrictions are supported: |
getParent
Required. The resource name of the project from which to list corpora.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the project from which to list corpora.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Requested page size. API may return fewer results than requested.
If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick use the maximum size, which is 20.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Requested page size. API may return fewer results than requested.
If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick use the maximum size, which is 20.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
A token identifying a page of results for the server to return.
Typically obtained via ListCorporaResponse.next_page_token of the previous Warehouse.ListCorpora call.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
A token identifying a page of results for the server to return.
Typically obtained via ListCorporaResponse.next_page_token of the previous Warehouse.ListCorpora call.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
The filter applied to the returned corpora list.
Only the following restrictions are supported:
type=<Corpus.Type>,
type!=<Corpus.Type>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
The filter applied to the returned corpora list.
Only the following restrictions are supported:
type=<Corpus.Type>,
type!=<Corpus.Type>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|