(::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.
value (::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.
Returns
(::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.
#receiver
defreceiver()->::String
Returns
(::String) — A name for the receiver to self-identify.
This is used to keep track of a receiver's read progress.
#receiver=
defreceiver=(value)->::String
Parameter
value (::String) — A name for the receiver to self-identify.
This is used to keep track of a receiver's read progress.
Returns
(::String) — A name for the receiver to self-identify.
This is used to keep track of a receiver's read progress.
#stream
defstream()->::String
Returns
(::String) — The stream name. The service will return the events for the given stream.
#stream=
defstream=(value)->::String
Parameter
value (::String) — The stream name. The service will return the events for the given stream.
Returns
(::String) — The stream name. The service will return the events for the given stream.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::ReceiveEventsRequest::SetupRequest (v1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-ReceiveEventsRequest-SetupRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-ReceiveEventsRequest-SetupRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-ReceiveEventsRequest-SetupRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-ReceiveEventsRequest-SetupRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-ReceiveEventsRequest-SetupRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-ReceiveEventsRequest-SetupRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-ReceiveEventsRequest-SetupRequest) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::ReceiveEventsRequest::SetupRequest.\n\nSetupRequest is the first message sent to the service to setup the RPC\nconnection. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #cluster\n\n def cluster() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The cluster name.\n\n### #cluster=\n\n def cluster=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The cluster name. \n**Returns**\n\n- (::String) --- The cluster name.\n\n### #controlled_mode\n\n def controlled_mode() -\u003e ::Google::Cloud::VisionAI::V1::ControlledMode\n\n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::ControlledMode](./Google-Cloud-VisionAI-V1-ControlledMode)) --- Controller mode configuration for receiving events from the server.\n\n### #controlled_mode=\n\n def controlled_mode=(value) -\u003e ::Google::Cloud::VisionAI::V1::ControlledMode\n\n**Parameter**\n\n- **value** ([::Google::Cloud::VisionAI::V1::ControlledMode](./Google-Cloud-VisionAI-V1-ControlledMode)) --- Controller mode configuration for receiving events from the server. \n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::ControlledMode](./Google-Cloud-VisionAI-V1-ControlledMode)) --- Controller mode configuration for receiving events from the server.\n\n### #heartbeat_interval\n\n def heartbeat_interval() -\u003e ::Google::Protobuf::Duration\n\n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- The maximum duration of server silence before the client determines the server unreachable.\n\n\n The client must either receive an `Event` update or a heart beat message\n before this duration expires; otherwise, the client will automatically\n cancel the current connection and retry.\n\n### #heartbeat_interval=\n\n def heartbeat_interval=(value) -\u003e ::Google::Protobuf::Duration\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- The maximum duration of server silence before the client determines the server unreachable.\n\n\n The client must either receive an `Event` update or a heart beat message\n before this duration expires; otherwise, the client will automatically\ncancel the current connection and retry. \n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- The maximum duration of server silence before the client determines the server unreachable.\n\n\n The client must either receive an `Event` update or a heart beat message\n before this duration expires; otherwise, the client will automatically\n cancel the current connection and retry.\n\n### #receiver\n\n def receiver() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A name for the receiver to self-identify.\n\n This is used to keep track of a receiver's read progress.\n\n### #receiver=\n\n def receiver=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A name for the receiver to self-identify.\n\n\nThis is used to keep track of a receiver's read progress. \n**Returns**\n\n- (::String) --- A name for the receiver to self-identify.\n\n This is used to keep track of a receiver's read progress.\n\n### #stream\n\n def stream() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The stream name. The service will return the events for the given stream.\n\n### #stream=\n\n def stream=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The stream name. The service will return the events for the given stream. \n**Returns**\n\n- (::String) --- The stream name. The service will return the events for the given stream.\n\n### #writes_done_grace_period\n\n def writes_done_grace_period() -\u003e ::Google::Protobuf::Duration\n\n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- The grace period after which a `writes_done_request` is issued, that a `WritesDone` is expected from the client.\n\n\n The server is free to cancel the RPC should this expire.\n\n A system default will be chosen if unset.\n\n### #writes_done_grace_period=\n\n def writes_done_grace_period=(value) -\u003e ::Google::Protobuf::Duration\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- The grace period after which a `writes_done_request` is issued, that a `WritesDone` is expected from the client.\n\n\n The server is free to cancel the RPC should this expire.\n\nA system default will be chosen if unset. \n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- The grace period after which a `writes_done_request` is issued, that a `WritesDone` is expected from the client.\n\n\n The server is free to cancel the RPC should this expire.\n\n A system default will be chosen if unset."]]
