Class: Google::Cloud::VisionAI::V1::ReceivePacketsRequest

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 receiving packets.

Defined Under Namespace

Classes: SetupRequest

Instance Attribute Summary collapse

Instance Attribute Details

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 279

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

  # The message specifying the initial settings for the ReceivePackets session.
  # @!attribute [rw] eager_receive_mode
  #   @return [::Google::Cloud::VisionAI::V1::EagerMode]
  #     Options for configuring eager mode.
  #
  #     Note: The following fields are mutually exclusive: `eager_receive_mode`, `controlled_receive_mode`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] controlled_receive_mode
  #   @return [::Google::Cloud::VisionAI::V1::ControlledMode]
  #     Options for configuring controlled mode.
  #
  #     Note: The following fields are mutually exclusive: `controlled_receive_mode`, `eager_receive_mode`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] metadata
  #   @return [::Google::Cloud::VisionAI::V1::RequestMetadata]
  #     The configurations that specify where packets are retrieved.
  # @!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] heartbeat_interval
  #   @return [::Google::Protobuf::Duration]
  #     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.
  # @!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::ReceivePacketsRequest::SetupRequest 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_service.rb', line 279

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

  # The message specifying the initial settings for the ReceivePackets session.
  # @!attribute [rw] eager_receive_mode
  #   @return [::Google::Cloud::VisionAI::V1::EagerMode]
  #     Options for configuring eager mode.
  #
  #     Note: The following fields are mutually exclusive: `eager_receive_mode`, `controlled_receive_mode`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] controlled_receive_mode
  #   @return [::Google::Cloud::VisionAI::V1::ControlledMode]
  #     Options for configuring controlled mode.
  #
  #     Note: The following fields are mutually exclusive: `controlled_receive_mode`, `eager_receive_mode`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] metadata
  #   @return [::Google::Cloud::VisionAI::V1::RequestMetadata]
  #     The configurations that specify where packets are retrieved.
  # @!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] heartbeat_interval
  #   @return [::Google::Protobuf::Duration]
  #     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.
  # @!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