public interface ListIndexEndpointsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getFilter()
public abstract String 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"
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes() 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"
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
public abstract int 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.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public abstract String getPageToken()Optional. A token identifying a page of results the server should return.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()Optional. A token identifying a page of results the server should return.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public abstract String getParent() Required. Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes() Required. Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |