Class: Google::Cloud::VisionAI::V1::ReceiveEventsControlResponse

Inherits:

Object

Object
Google::Cloud::VisionAI::V1::ReceiveEventsControlResponse

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/visionai/v1/streaming_service.rb

Overview

Control message for a ReceiveEventsResponse.

Instance Attribute Summary collapse

#heartbeat ⇒ ::Boolean
A server heartbeat.
#writes_done_request ⇒ ::Boolean
A request to the receiver to complete any final writes followed by a WritesDone; e.g.

Instance Attribute Details

#heartbeat ⇒ `::Boolean`

Returns 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.

# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 118

class ReceiveEventsControlResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#writes_done_request ⇒ `::Boolean`

Returns 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.