Google Cloud Vision Ai V1 Client - Class ReceivePacketsControlResponse (0.1.0)

Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class ReceivePacketsControlResponse.

Control message for a ReceivePacketsResponse.

Generated from protobuf message google.cloud.visionai.v1.ReceivePacketsControlResponse

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ heartbeat bool

A server heartbeat.

↳ writes_done_request bool

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.

getHeartbeat

A server heartbeat.

Returns
Type Description
bool

hasHeartbeat

setHeartbeat

A server heartbeat.

Parameter
Name Description
var bool
Returns
Type Description
$this

getWritesDoneRequest

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.

Returns
Type Description
bool

hasWritesDoneRequest

setWritesDoneRequest

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getControl

Returns
Type Description
string