public static final class ListIndexEndpointsRequest.Builder extends GeneratedMessageV3.Builder<ListIndexEndpointsRequest.Builder> implements ListIndexEndpointsRequestOrBuilderRequest message for ListIndexEndpoints.
Protobuf type google.cloud.visionai.v1.ListIndexEndpointsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListIndexEndpointsRequest.BuilderImplements
ListIndexEndpointsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListIndexEndpointsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
build()
public ListIndexEndpointsRequest build()| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest |
|
buildPartial()
public ListIndexEndpointsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest |
|
clear()
public ListIndexEndpointsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListIndexEndpointsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
clearFilter()
public ListIndexEndpointsRequest.Builder clearFilter() 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 |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListIndexEndpointsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
clearPageSize()
public ListIndexEndpointsRequest.Builder clearPageSize()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 |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListIndexEndpointsRequest.Builder clearPageToken()Optional. A token identifying a page of results the server should return.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
clearParent()
public ListIndexEndpointsRequest.Builder clearParent() Required. Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
clone()
public ListIndexEndpointsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
getDefaultInstanceForType()
public ListIndexEndpointsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListIndexEndpointsRequest other)
public ListIndexEndpointsRequest.Builder mergeFrom(ListIndexEndpointsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListIndexEndpointsRequest |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListIndexEndpointsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListIndexEndpointsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListIndexEndpointsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListIndexEndpointsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
setFilter(String value)
public ListIndexEndpointsRequest.Builder setFilter(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListIndexEndpointsRequest.Builder setFilterBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListIndexEndpointsRequest.Builder setPageSize(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListIndexEndpointsRequest.Builder setPageToken(String value)Optional. A token identifying a page of results the server should return.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListIndexEndpointsRequest.Builder setPageTokenBytes(ByteString value)Optional. A token identifying a page of results the server should return.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListIndexEndpointsRequest.Builder setParent(String value) Required. Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListIndexEndpointsRequest.Builder setParentBytes(ByteString value) Required. Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListIndexEndpointsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListIndexEndpointsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListIndexEndpointsRequest.Builder |
|