Send feedback
Class ListIndexEndpointsRequest (0.12.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.12.0 keyboard_arrow_down
public final class ListIndexEndpointsRequest extends GeneratedMessageV3 implements ListIndexEndpointsRequestOrBuilder
Request message for ListIndexEndpoints.
Protobuf type google.cloud.visionai.v1.ListIndexEndpointsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type
Description
int
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type
Description
int
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type
Description
int
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static ListIndexEndpointsRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ListIndexEndpointsRequest . Builder newBuilder ()
newBuilder(ListIndexEndpointsRequest prototype)
public static ListIndexEndpointsRequest . Builder newBuilder ( ListIndexEndpointsRequest prototype )
public static ListIndexEndpointsRequest parseDelimitedFrom ( InputStream input )
public static ListIndexEndpointsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ListIndexEndpointsRequest parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListIndexEndpointsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ListIndexEndpointsRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListIndexEndpointsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ListIndexEndpointsRequest parseFrom ( CodedInputStream input )
public static ListIndexEndpointsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ListIndexEndpointsRequest parseFrom ( InputStream input )
public static ListIndexEndpointsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ListIndexEndpointsRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListIndexEndpointsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ListIndexEndpointsRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public ListIndexEndpointsRequest getDefaultInstanceForType ()
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()
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.
getParserForType()
public Parser<ListIndexEndpointsRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ListIndexEndpointsRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListIndexEndpointsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public ListIndexEndpointsRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]