Vision AI V1 API - Class Google::Cloud::VisionAI::V1::ReceiveEventsControlResponse (v1.2.0)

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

def heartbeat() -> ::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=

def heartbeat=(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

def writes_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=

def writes_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.