Interface ListAnnotationsRequestOrBuilder (0.5.0)

public interface ListAnnotationsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.