Class ListCollectionsRequest (0.2.0)

public final class ListCollectionsRequest extends GeneratedMessageV3 implements ListCollectionsRequestOrBuilder

Request message for ListCollections.

Protobuf type google.cloud.visionai.v1.ListCollectionsRequest

Static Fields

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 ListCollectionsRequest getDefaultInstance()
Returns
Type Description
ListCollectionsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListCollectionsRequest.Builder newBuilder()
Returns
Type Description
ListCollectionsRequest.Builder

newBuilder(ListCollectionsRequest prototype)

public static ListCollectionsRequest.Builder newBuilder(ListCollectionsRequest prototype)
Parameter
Name Description
prototype ListCollectionsRequest
Returns
Type Description
ListCollectionsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListCollectionsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListCollectionsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListCollectionsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListCollectionsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListCollectionsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListCollectionsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListCollectionsRequest> parser()
Returns
Type Description
Parser<ListCollectionsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListCollectionsRequest getDefaultInstanceForType()
Returns
Type Description
ListCollectionsRequest

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 ListCollectionsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCollectionsRequest 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 ListCollectionsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCollectionsRequest must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent corpus. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent corpus. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListCollectionsRequest> getParserForType()
Returns
Type Description
Parser<ListCollectionsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListCollectionsRequest.Builder newBuilderForType()
Returns
Type Description
ListCollectionsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListCollectionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListCollectionsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListCollectionsRequest.Builder toBuilder()
Returns
Type Description
ListCollectionsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException