Vision AI v1 API - Class ReceiveEventsRequest.Types.SetupRequest (1.0.0-beta01)

public sealed class ReceiveEventsRequest.Types.SetupRequest : IMessage<ReceiveEventsRequest.Types.SetupRequest>, IEquatable<ReceiveEventsRequest.Types.SetupRequest>, IDeepCloneable<ReceiveEventsRequest.Types.SetupRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Vision AI v1 API class ReceiveEventsRequest.Types.SetupRequest.

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

Inheritance

object > ReceiveEventsRequest.Types.SetupRequest

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

SetupRequest()

public SetupRequest()

SetupRequest(SetupRequest)

public SetupRequest(ReceiveEventsRequest.Types.SetupRequest other)
Parameter
Name Description
other ReceiveEventsRequestTypesSetupRequest

Properties

Cluster

public string Cluster { get; set; }

The cluster name.

Property Value
Type Description
string

ControlledMode

public ControlledMode ControlledMode { get; set; }

Controller mode configuration for receiving events from the server.

Property Value
Type Description
ControlledMode

HeartbeatInterval

public Duration HeartbeatInterval { get; set; }

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.

Property Value
Type Description
Duration

Receiver

public string Receiver { get; set; }

A name for the receiver to self-identify.

This is used to keep track of a receiver's read progress.

Property Value
Type Description
string

Stream

public string Stream { get; set; }

The stream name. The service will return the events for the given stream.

Property Value
Type Description
string

WritesDoneGracePeriod

public Duration WritesDoneGracePeriod { get; set; }

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.

Property Value
Type Description
Duration