Vision AI v1 API - Class ControlledMode (1.0.0-beta01)

public sealed class ControlledMode : IMessage<ControlledMode>, IEquatable<ControlledMode>, IDeepCloneable<ControlledMode>, IBufferMessage, IMessage

Reference documentation and code samples for the Vision AI v1 API class ControlledMode.

The options for receiver under the controlled mode.

Inheritance

object > ControlledMode

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

ControlledMode()

public ControlledMode()

ControlledMode(ControlledMode)

public ControlledMode(ControlledMode other)
Parameter
Name Description
other ControlledMode

Properties

FallbackStartingOffset

public string FallbackStartingOffset { get; set; }

This is the logical starting point to fallback upon should the specified starting offset be unavailable.

This can be one of the following values:

"begin": This will read from the earliest available message.

"end": This will read only future messages.

Property Value
Type Description
string

HasStartingLogicalOffset

public bool HasStartingLogicalOffset { get; }

Gets whether the "starting_logical_offset" field is set

Property Value
Type Description
bool

StartingLogicalOffset

public string StartingLogicalOffset { get; set; }

This can be set to the following logical starting points:

"begin": This will read from the earliest available message.

"most-recent": This will read from the latest available message.

"end": This will read only future messages.

"stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.

Property Value
Type Description
string

StartingOffsetCase

public ControlledMode.StartingOffsetOneofCase StartingOffsetCase { get; }
Property Value
Type Description
ControlledModeStartingOffsetOneofCase