Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::ListAnnotationsRequest.
Request message for GetAnnotation API.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::String) — 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""
#filter=
deffilter=(value)->::String
Parameter
value (::String) — 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""
Returns
(::String) — 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""
#page_size
defpage_size()->::Integer
Returns
(::Integer) — 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.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — 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.
Returns
(::Integer) — 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.
#page_token
defpage_token()->::String
Returns
(::String) — 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.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — 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.
Returns
(::String) — 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.
#parent
defparent()->::String
Returns
(::String) — The parent, which owns this collection of annotations.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}
#parent=
defparent=(value)->::String
Parameter
value (::String) — The parent, which owns this collection of annotations.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}
Returns
(::String) — The parent, which owns this collection of annotations.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::ListAnnotationsRequest (v1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-ListAnnotationsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-ListAnnotationsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-ListAnnotationsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-ListAnnotationsRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-ListAnnotationsRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-ListAnnotationsRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-ListAnnotationsRequest) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::ListAnnotationsRequest.\n\nRequest message for GetAnnotation API. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- 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 \\\u003e \"2012-04-21T11:30:00-04:00\" AND partition.temporal_partition.end_time \\\u003c \"2012-04-22T11:30:00-04:00\" AND key = \"example_key\"\"\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- 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 \\\u003e \"2012-04-21T11:30:00-04:00\" AND partition.temporal_partition.end_time \\\u003c \"2012-04-22T11:30:00-04:00\" AND key = \"example_key\"\" \n**Returns**\n\n- (::String) --- 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 \\\u003e \"2012-04-21T11:30:00-04:00\" AND partition.temporal_partition.end_time \\\u003c \"2012-04-22T11:30:00-04:00\" AND key = \"example_key\"\"\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- 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.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- 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. \n**Returns**\n\n- (::Integer) --- 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.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A page token, received from a previous `ListAnnotations` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListAnnotations` must\n match the call that provided the page token.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A page token, received from a previous `ListAnnotations` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListAnnotations` must\nmatch the call that provided the page token. \n**Returns**\n\n- (::String) --- A page token, received from a previous `ListAnnotations` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListAnnotations` must\n match the call that provided the page token.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The parent, which owns this collection of annotations. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}`\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The parent, which owns this collection of annotations. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}` \n**Returns**\n\n- (::String) --- The parent, which owns this collection of annotations. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}`"]]
