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

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

SetupRequest is the first message sent to the service to setup the RPC connection.

Generated from protobuf message google.cloud.visionai.v1.ReceiveEventsRequest.SetupRequest

Namespace

Google \ Cloud \ VisionAI \ V1 \ ReceiveEventsRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ cluster`	`string` The cluster name.
`↳ stream`	`string` The stream name. The service will return the events for the given stream.
`↳ receiver`	`string` A name for the receiver to self-identify. This is used to keep track of a receiver's read progress.
`↳ controlled_mode`	`Google\Cloud\VisionAI\V1\ControlledMode` Controller mode configuration for receiving events from the server.
`↳ heartbeat_interval`	`Google\Protobuf\Duration` The maximum duration of server silence before the client determines the server unreachable. The client must either receive an `Event` update or a heart beat message before this duration expires; otherwise, the client will automatically cancel the current connection and retry.
`↳ writes_done_grace_period`	`Google\Protobuf\Duration` 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.

getCluster

The cluster name.

Returns
Type	Description
`string`

setCluster

The cluster name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStream

The stream name. The service will return the events for the given stream.

Returns
Type	Description
`string`

setStream

The stream name. The service will return the events for the given stream.

Parameter
Name	Description
`var`	`string`

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`

getControlledMode

Controller mode configuration for receiving events from the server.

Returns
Type	Description
`Google\Cloud\VisionAI\V1\ControlledMode\|null`

hasControlledMode

clearControlledMode

setControlledMode

Controller mode configuration for receiving events from the server.

Parameter
Name	Description
`var`	`Google\Cloud\VisionAI\V1\ControlledMode`

Returns
Type	Description
`$this`

getHeartbeatInterval

The maximum duration of server silence before the client determines the server unreachable.

The client must either receive an Event update 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