Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class ListIndexEndpointsRequest.
Request message for ListIndexEndpoints.
Generated from protobuf message google.cloud.visionai.v1.ListIndexEndpointsRequest
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Format: |
↳ page_size |
int
Optional. Requested page size. Server may return fewer items than requested. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. A token identifying a page of results the server should return. |
↳ filter |
string
Optional. The filter applied to the returned list. We only support filtering for the |
getParent
Required. Format: projects/{project}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. Format: projects/{project}/locations/{location}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. Requested page size. Server may return fewer items than requested. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. Requested page size. Server may return fewer items than requested. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A token identifying a page of results the server should return.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A token identifying a page of results the server should return.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. The filter applied to the returned list.
We only support filtering for the deployed_image_index.image_index field.
However, to filter by a corpus instead of an image index, simply use
deployed_image_index.corpus, which will return all endpoints with
deployed_image_index.image_index inside of the given corpus.
A basic filter on image index would look like:
deployed_image_index.image_index =
"projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
A basic filter on corpus would look like:
deployed_image_index.corpus =
"projects/123/locations/us-central1/corpora/my_corpus"
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. The filter applied to the returned list.
We only support filtering for the deployed_image_index.image_index field.
However, to filter by a corpus instead of an image index, simply use
deployed_image_index.corpus, which will return all endpoints with
deployed_image_index.image_index inside of the given corpus.
A basic filter on image index would look like:
deployed_image_index.image_index =
"projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
A basic filter on corpus would look like:
deployed_image_index.corpus =
"projects/123/locations/us-central1/corpora/my_corpus"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|