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

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

Request message for ReceiveEvents.

Defined Under Namespace

Classes: SetupRequest

Instance Attribute Summary collapse

Instance Attribute Details

#commit_request ⇒ ::Google::Cloud::VisionAI::V1::CommitRequest

Returns This request checkpoints the consumer's read progress.

Note: The following fields are mutually exclusive: commit_request, setup_request. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::VisionAI::V1::CommitRequest) —

    This request checkpoints the consumer's read progress.

    Note: The following fields are mutually exclusive: commit_request, setup_request. If a field in that set is populated, all other fields in the set will automatically be cleared.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 35

class ReceiveEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # SetupRequest is the first message sent to the service to setup the RPC
  # connection.
  # @!attribute [rw] cluster
  #   @return [::String]
  #     The cluster name.
  # @!attribute [rw] stream
  #   @return [::String]
  #     The stream name. The service will return the events for the given stream.
  # @!attribute [rw] receiver
  #   @return [::String]
  #     A name for the receiver to self-identify.
  #
  #     This is used to keep track of a receiver's read progress.
  # @!attribute [rw] controlled_mode
  #   @return [::Google::Cloud::VisionAI::V1::ControlledMode]
  #     Controller mode configuration for receiving events from the server.
  # @!attribute [rw] heartbeat_interval
  #   @return [::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.
  # @!attribute [rw] writes_done_grace_period
  #   @return [::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.
  class SetupRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#setup_request ⇒ ::Google::Cloud::VisionAI::V1::ReceiveEventsRequest::SetupRequest

Returns The setup request to setup the RPC connection.

Note: The following fields are mutually exclusive: setup_request, commit_request. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 35

class ReceiveEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # SetupRequest is the first message sent to the service to setup the RPC
  # connection.
  # @!attribute [rw] cluster
  #   @return [::String]
  #     The cluster name.
  # @!attribute [rw] stream
  #   @return [::String]
  #     The stream name. The service will return the events for the given stream.
  # @!attribute [rw] receiver
  #   @return [::String]
  #     A name for the receiver to self-identify.
  #
  #     This is used to keep track of a receiver's read progress.
  # @!attribute [rw] controlled_mode
  #   @return [::Google::Cloud::VisionAI::V1::ControlledMode]
  #     Controller mode configuration for receiving events from the server.
  # @!attribute [rw] heartbeat_interval
  #   @return [::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.
  # @!attribute [rw] writes_done_grace_period
  #   @return [::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.
  class SetupRequest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end