Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class SetupRequest.
The message specifying the initial settings for the ReceivePackets session.
Generated from protobuf message google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequest
Namespace
Google \ Cloud \ VisionAI \ V1 \ ReceivePacketsRequestMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ eager_receive_mode |
Google\Cloud\VisionAI\V1\EagerMode
Options for configuring eager mode. |
↳ controlled_receive_mode |
Google\Cloud\VisionAI\V1\ControlledMode
Options for configuring controlled mode. |
↳ metadata |
Google\Cloud\VisionAI\V1\RequestMetadata
The configurations that specify where packets are retrieved. |
↳ receiver |
string
A name for the receiver to self-identify. This is used to keep track of a receiver's read progress. |
↳ heartbeat_interval |
Google\Protobuf\Duration
The maximum duration of server silence before the client determines the server unreachable. The client must either receive a |
↳ writes_done_grace_period |
Google\Protobuf\Duration
The grace period after which a |
getEagerReceiveMode
Options for configuring eager mode.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VisionAI\V1\EagerMode|null |
|
hasEagerReceiveMode
setEagerReceiveMode
Options for configuring eager mode.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VisionAI\V1\EagerMode
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getControlledReceiveMode
Options for configuring controlled mode.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VisionAI\V1\ControlledMode|null |
|
hasControlledReceiveMode
setControlledReceiveMode
Options for configuring controlled mode.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VisionAI\V1\ControlledMode
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetadata
The configurations that specify where packets are retrieved.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VisionAI\V1\RequestMetadata|null |
|
hasMetadata
clearMetadata
setMetadata
The configurations that specify where packets are retrieved.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VisionAI\V1\RequestMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReceiver
A name for the receiver to self-identify.
This is used to keep track of a receiver's read progress.
| Returns | |
|---|---|
| Type | Description |
string |
|
setReceiver
A name for the receiver to self-identify.
This is used to keep track of a receiver's read progress.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHeartbeatInterval
The maximum duration of server silence before the client determines the server unreachable.
The client must either receive a Packet or a heart beat message before
this duration expires; otherwise, the client will automatically cancel
the current connection and retry.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasHeartbeatInterval
clearHeartbeatInterval
setHeartbeatInterval
The maximum duration of server silence before the client determines the server unreachable.
The client must either receive a Packet or a heart beat message before
this duration expires; otherwise, the client will automatically cancel
the current connection and retry.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWritesDoneGracePeriod
The grace period after which a writes_done_request is issued, that a
WritesDone is expected from the client.
The server is free to cancel the RPC should this expire. A system default will be chosen if unset.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasWritesDoneGracePeriod
clearWritesDoneGracePeriod
setWritesDoneGracePeriod
The grace period after which a writes_done_request is issued, that a
WritesDone is expected from the client.
The server is free to cancel the RPC should this expire. A system default will be chosen if unset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConsumerMode
| Returns | |
|---|---|
| Type | Description |
string |
|