Class ListAnnotationsRequest (0.1.0)

public final class ListAnnotationsRequest extends GeneratedMessageV3 implements ListAnnotationsRequestOrBuilder

Request message for GetAnnotation API.

Protobuf type google.cloud.visionai.v1.ListAnnotationsRequest

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

getDescriptor()

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

newBuilder()

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

newBuilder(ListAnnotationsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ListAnnotationsRequest getDefaultInstanceForType()
Returns
Type Description
ListAnnotationsRequest

getFilter()

public String getFilter()

The filter applied to the returned list. We only support filtering for the following fields: For corpus of STREAM_VIDEO type: partition.temporal_partition.start_time, partition.temporal_partition.end_time, and key. For corpus of VIDEO_ON_DEMAND type, partition.relative_temporal_partition.start_offset, partition.relative_temporal_partition.end_offset, and key. For corpus of IMAGE type, only key is supported. Timestamps are specified in the RFC-3339 format, and only one restriction may be applied per field, joined by conjunctions. Format: "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND key = "example_key""

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter applied to the returned list. We only support filtering for the following fields: For corpus of STREAM_VIDEO type: partition.temporal_partition.start_time, partition.temporal_partition.end_time, and key. For corpus of VIDEO_ON_DEMAND type, partition.relative_temporal_partition.start_offset, partition.relative_temporal_partition.end_offset, and key. For corpus of IMAGE type, only key is supported. Timestamps are specified in the RFC-3339 format, and only one restriction may be applied per field, joined by conjunctions. Format: "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND key = "example_key""

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations 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 ListAnnotations call. Provide this to retrieve the subsequent page.

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

When paginating, all other parameters provided to ListAnnotations 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()

The parent, which owns this collection of annotations. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

The parent, which owns this collection of annotations. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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