Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::ReceiveEventsControlResponse.
Control message for a ReceiveEventsResponse.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#heartbeat
defheartbeat()->::Boolean
Returns
(::Boolean) — A server heartbeat.
Note: The following fields are mutually exclusive: heartbeat, writes_done_request. If a field in that set is populated, all other fields in the set will automatically be cleared.
#heartbeat=
defheartbeat=(value)->::Boolean
Parameter
value (::Boolean) — A server heartbeat.
Note: The following fields are mutually exclusive: heartbeat, writes_done_request. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::Boolean) — A server heartbeat.
Note: The following fields are mutually exclusive: heartbeat, writes_done_request. If a field in that set is populated, all other fields in the set will automatically be cleared.
#writes_done_request
defwrites_done_request()->::Boolean
Returns
(::Boolean) — A request to the receiver to complete any final writes followed by a
WritesDone; e.g. issue any final CommitRequests.
May be ignored if WritesDone has already been issued at any point
prior to receiving this message.
If WritesDone does not get issued, then the server will forcefully
cancel the connection, and the receiver will likely receive an
uninformative after Read returns false and Finish is called.
Note: The following fields are mutually exclusive: writes_done_request, heartbeat. If a field in that set is populated, all other fields in the set will automatically be cleared.
#writes_done_request=
defwrites_done_request=(value)->::Boolean
Parameter
value (::Boolean) — A request to the receiver to complete any final writes followed by a
WritesDone; e.g. issue any final CommitRequests.
May be ignored if WritesDone has already been issued at any point
prior to receiving this message.
If WritesDone does not get issued, then the server will forcefully
cancel the connection, and the receiver will likely receive an
uninformative after Read returns false and Finish is called.
Note: The following fields are mutually exclusive: writes_done_request, heartbeat. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::Boolean) — A request to the receiver to complete any final writes followed by a
WritesDone; e.g. issue any final CommitRequests.
May be ignored if WritesDone has already been issued at any point
prior to receiving this message.
If WritesDone does not get issued, then the server will forcefully
cancel the connection, and the receiver will likely receive an
uninformative after Read returns false and Finish is called.
Note: The following fields are mutually exclusive: writes_done_request, heartbeat. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["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::ReceiveEventsControlResponse (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-ReceiveEventsControlResponse)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-ReceiveEventsControlResponse)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-ReceiveEventsControlResponse)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-ReceiveEventsControlResponse)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-ReceiveEventsControlResponse)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-ReceiveEventsControlResponse)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-ReceiveEventsControlResponse) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::ReceiveEventsControlResponse.\n\nControl message for a ReceiveEventsResponse. \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### #heartbeat\n\n def heartbeat() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- A server heartbeat.\n\n Note: The following fields are mutually exclusive: `heartbeat`, `writes_done_request`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #heartbeat=\n\n def heartbeat=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- A server heartbeat.\n\n\nNote: The following fields are mutually exclusive: `heartbeat`, `writes_done_request`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::Boolean) --- A server heartbeat.\n\n Note: The following fields are mutually exclusive: `heartbeat`, `writes_done_request`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #writes_done_request\n\n def writes_done_request() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- A request to the receiver to complete any final writes followed by a `WritesDone`; e.g. issue any final `CommitRequest`s.\n\n\n May be ignored if `WritesDone` has already been issued at any point\n prior to receiving this message.\n\n If `WritesDone` does not get issued, then the server will forcefully\n cancel the connection, and the receiver will likely receive an\n uninformative after `Read` returns `false` and `Finish` is called.\n\n Note: The following fields are mutually exclusive: `writes_done_request`, `heartbeat`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #writes_done_request=\n\n def writes_done_request=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- A request to the receiver to complete any final writes followed by a `WritesDone`; e.g. issue any final `CommitRequest`s.\n\n\n May be ignored if `WritesDone` has already been issued at any point\n prior to receiving this message.\n\n If `WritesDone` does not get issued, then the server will forcefully\n cancel the connection, and the receiver will likely receive an\n uninformative after `Read` returns `false` and `Finish` is called.\n\nNote: The following fields are mutually exclusive: `writes_done_request`, `heartbeat`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::Boolean) --- A request to the receiver to complete any final writes followed by a `WritesDone`; e.g. issue any final `CommitRequest`s.\n\n\n May be ignored if `WritesDone` has already been issued at any point\n prior to receiving this message.\n\n If `WritesDone` does not get issued, then the server will forcefully\n cancel the connection, and the receiver will likely receive an\n uninformative after `Read` returns `false` and `Finish` is called.\n\n Note: The following fields are mutually exclusive: `writes_done_request`, `heartbeat`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]
