public final class ViewCollectionItemsRequest extends GeneratedMessageV3 implements ViewCollectionItemsRequestOrBuilder
Request message for ViewCollectionItems.
Protobuf type google.cloud.visionai.v1.ViewCollectionItemsRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ViewCollectionItemsRequestImplements
ViewCollectionItemsRequestOrBuilderStatic Fields
COLLECTION_FIELD_NUMBER
public static final int COLLECTION_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 |
Static Methods
getDefaultInstance()
public static ViewCollectionItemsRequest getDefaultInstance()
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static ViewCollectionItemsRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest.Builder |
newBuilder(ViewCollectionItemsRequest prototype)
public static ViewCollectionItemsRequest.Builder newBuilder(ViewCollectionItemsRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype |
ViewCollectionItemsRequest |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest.Builder |
parseDelimitedFrom(InputStream input)
public static ViewCollectionItemsRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ViewCollectionItemsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static ViewCollectionItemsRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ViewCollectionItemsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ViewCollectionItemsRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ViewCollectionItemsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ViewCollectionItemsRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ViewCollectionItemsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static ViewCollectionItemsRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ViewCollectionItemsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static ViewCollectionItemsRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ViewCollectionItemsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<ViewCollectionItemsRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<ViewCollectionItemsRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getCollection()
public String getCollection()
Required. The collection to view. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
string collection = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The collection. |
getCollectionBytes()
public ByteString getCollectionBytes()
Required. The collection to view. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
string collection = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for collection. |
getDefaultInstanceForType()
public ViewCollectionItemsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest |
getPageSize()
public int getPageSize()
The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
Returns | |
---|---|
Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()
A page token, received from a previous ViewCollectionItemsRequest
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ViewCollectionItemsRequest
must match the call that provided the page
token.
string page_token = 3;
Returns | |
---|---|
Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous ViewCollectionItemsRequest
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ViewCollectionItemsRequest
must match the call that provided the page
token.
string page_token = 3;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for pageToken. |
getParserForType()
public Parser<ViewCollectionItemsRequest> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<ViewCollectionItemsRequest> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public ViewCollectionItemsRequest.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ViewCollectionItemsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public ViewCollectionItemsRequest.Builder toBuilder()
Returns | |
---|---|
Type | Description |
ViewCollectionItemsRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |