Note: The following fields are mutually exclusive: active_zone, crossing_line. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: active_zone, crossing_line. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: active_zone, crossing_line. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: crossing_line, active_zone. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: crossing_line, active_zone. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: crossing_line, active_zone. If a field in that set is populated, all other fields in the set will automatically be cleared.
#display_name
defdisplay_name()->::String
Returns
(::String) — User-friendly name for the annotation.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — User-friendly name for the annotation.
Returns
(::String) — User-friendly name for the annotation.
#id
defid()->::String
Returns
(::String) — ID of the annotation. It must be unique when used in the certain context.
For example, all the annotations to one input streams of a Vision AI
application.
#id=
defid=(value)->::String
Parameter
value (::String) — ID of the annotation. It must be unique when used in the certain context.
For example, all the annotations to one input streams of a Vision AI
application.
Returns
(::String) — ID of the annotation. It must be unique when used in the certain context.
For example, all the annotations to one input streams of a Vision AI
application.
#source_stream
defsource_stream()->::String
Returns
(::String) — The Vision AI stream resource name.
#source_stream=
defsource_stream=(value)->::String
Parameter
value (::String) — The Vision AI stream resource name.
[[["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::StreamAnnotation (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-StreamAnnotation)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-StreamAnnotation)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-StreamAnnotation)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-StreamAnnotation)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-StreamAnnotation)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-StreamAnnotation)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-StreamAnnotation) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::StreamAnnotation.\n\nmessage about annotations about Vision AI stream resource. \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### #active_zone\n\n def active_zone() -\u003e ::Google::Cloud::VisionAI::V1::NormalizedPolygon\n\n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::NormalizedPolygon](./Google-Cloud-VisionAI-V1-NormalizedPolygon)) --- Annotation for type ACTIVE_ZONE\n\n\n Note: The following fields are mutually exclusive: `active_zone`, `crossing_line`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #active_zone=\n\n def active_zone=(value) -\u003e ::Google::Cloud::VisionAI::V1::NormalizedPolygon\n\n**Parameter**\n\n- **value** ([::Google::Cloud::VisionAI::V1::NormalizedPolygon](./Google-Cloud-VisionAI-V1-NormalizedPolygon)) --- Annotation for type ACTIVE_ZONE\n\n\nNote: The following fields are mutually exclusive: `active_zone`, `crossing_line`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::NormalizedPolygon](./Google-Cloud-VisionAI-V1-NormalizedPolygon)) --- Annotation for type ACTIVE_ZONE\n\n\n Note: The following fields are mutually exclusive: `active_zone`, `crossing_line`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #crossing_line\n\n def crossing_line() -\u003e ::Google::Cloud::VisionAI::V1::NormalizedPolyline\n\n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::NormalizedPolyline](./Google-Cloud-VisionAI-V1-NormalizedPolyline)) --- Annotation for type CROSSING_LINE\n\n\n Note: The following fields are mutually exclusive: `crossing_line`, `active_zone`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #crossing_line=\n\n def crossing_line=(value) -\u003e ::Google::Cloud::VisionAI::V1::NormalizedPolyline\n\n**Parameter**\n\n- **value** ([::Google::Cloud::VisionAI::V1::NormalizedPolyline](./Google-Cloud-VisionAI-V1-NormalizedPolyline)) --- Annotation for type CROSSING_LINE\n\n\nNote: The following fields are mutually exclusive: `crossing_line`, `active_zone`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::NormalizedPolyline](./Google-Cloud-VisionAI-V1-NormalizedPolyline)) --- Annotation for type CROSSING_LINE\n\n\n Note: The following fields are mutually exclusive: `crossing_line`, `active_zone`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- User-friendly name for the annotation.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- User-friendly name for the annotation. \n**Returns**\n\n- (::String) --- User-friendly name for the annotation.\n\n### #id\n\n def id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- ID of the annotation. It must be unique when used in the certain context. For example, all the annotations to one input streams of a Vision AI application.\n\n### #id=\n\n def id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- ID of the annotation. It must be unique when used in the certain context. For example, all the annotations to one input streams of a Vision AI application. \n**Returns**\n\n- (::String) --- ID of the annotation. It must be unique when used in the certain context. For example, all the annotations to one input streams of a Vision AI application.\n\n### #source_stream\n\n def source_stream() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The Vision AI stream resource name.\n\n### #source_stream=\n\n def source_stream=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The Vision AI stream resource name. \n**Returns**\n\n- (::String) --- The Vision AI stream resource name.\n\n### #type\n\n def type() -\u003e ::Google::Cloud::VisionAI::V1::StreamAnnotationType\n\n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::StreamAnnotationType](./Google-Cloud-VisionAI-V1-StreamAnnotationType)) --- The actual type of Annotation.\n\n### #type=\n\n def type=(value) -\u003e ::Google::Cloud::VisionAI::V1::StreamAnnotationType\n\n**Parameter**\n\n- **value** ([::Google::Cloud::VisionAI::V1::StreamAnnotationType](./Google-Cloud-VisionAI-V1-StreamAnnotationType)) --- The actual type of Annotation. \n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::StreamAnnotationType](./Google-Cloud-VisionAI-V1-StreamAnnotationType)) --- The actual type of Annotation."]]
