Class ListCorporaRequest (0.3.0)

public final class ListCorporaRequest extends GeneratedMessageV3 implements ListCorporaRequestOrBuilder

Request message for ListCorpora.

Protobuf type google.cloud.visionai.v1.ListCorporaRequest

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

getDescriptor()

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

newBuilder()

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

newBuilder(ListCorporaRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ListCorporaRequest getDefaultInstanceForType()
Returns
Type Description
ListCorporaRequest

getFilter()

public String getFilter()

The filter applied to the returned corpora list. Only the following restrictions are supported: type=<Corpus.Type>, type!=<Corpus.Type>.

string filter = 5;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter applied to the returned corpora list. Only the following restrictions are supported: type=<Corpus.Type>, type!=<Corpus.Type>.

string filter = 5;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Requested page size. API may return fewer results than requested. If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick use the maximum size, which is 20.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A token identifying a page of results for the server to return. Typically obtained via ListCorporaResponse.next_page_token of the previous Warehouse.ListCorpora call.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A token identifying a page of results for the server to return. Typically obtained via ListCorporaResponse.next_page_token of the previous Warehouse.ListCorpora call.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the project from which to list corpora.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the project from which to list corpora.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListCorporaRequest> getParserForType()
Returns
Type Description
Parser<ListCorporaRequest>
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 ListCorporaRequest.Builder newBuilderForType()
Returns
Type Description
ListCorporaRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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