Class: Google::Cloud::VisionAI::V1::ReceiveEventsRequest::SetupRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/streaming_service.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#cluster ⇒ ::String

Returns The cluster name.

Returns:

  • (::String) —

    The cluster name.



67
68
69
70
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 67

class SetupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#controlled_mode ⇒ ::Google::Cloud::VisionAI::V1::ControlledMode

Returns Controller mode configuration for receiving events from the server.

Returns:



67
68
69
70
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 67

class SetupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#heartbeat_interval ⇒ ::Google::Protobuf::Duration

Returns 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.



67
68
69
70
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 67

class SetupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#receiver ⇒ ::String

Returns 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.



67
68
69
70
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 67

class SetupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#stream ⇒ ::String

Returns 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.



67
68
69
70
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 67

class SetupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#writes_done_grace_period ⇒ ::Google::Protobuf::Duration

Returns 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:

  • (::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.



67
68
69
70
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 67

class SetupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end