Struct google_api_proto::google::cloud::visionai::v1::receive_events_request::SetupRequest

pub struct SetupRequest {
    pub cluster: String,
    pub stream: String,
    pub receiver: String,
    pub controlled_mode: Option<ControlledMode>,
    pub heartbeat_interval: Option<Duration>,
    pub writes_done_grace_period: Option<Duration>,
}

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

Fields

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: Option<ControlledMode>

Controller mode configuration for receiving events from the server.

heartbeat_interval: Option<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: Option<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.

Trait Implementations

impl Clone for SetupRequest

fn clone(&self) -> SetupRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SetupRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SetupRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SetupRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SetupRequest

fn eq(&self, other: &SetupRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SetupRequest