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

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

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

The message that represents packet header.

Inheritance

object > PacketHeader

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

PacketHeader()

public PacketHeader()

PacketHeader(PacketHeader)

public PacketHeader(PacketHeader other)
Parameter
Name Description
other PacketHeader

Properties

CaptureTime

public Timestamp CaptureTime { get; set; }

Input only. The capture time of the packet.

Property Value
Type Description
Timestamp

Flags

public int Flags { get; set; }

Immutable. Packet flag set. SDK will set the flag automatically.

Property Value
Type Description
int

Metadata

public Struct Metadata { get; set; }

Input only. This field is for users to attach user managed metadata.

Property Value
Type Description
Struct

SeriesMetadata

public SeriesMetadata SeriesMetadata { get; set; }

Input only. Immutable. Metadata that the server needs to know where to write the packets to. It's only required for the first packet.

Property Value
Type Description
SeriesMetadata

ServerMetadata

public ServerMetadata ServerMetadata { get; set; }

Output only. Metadata that the server appends to each packet before sending it to receivers. You don't need to set a value for this field when sending packets.

Property Value
Type Description
ServerMetadata

TraceContext

public string TraceContext { get; set; }

Immutable. Header string for tracing across services. It should be set when the packet is first arrived in the stream server.

The input format is a lowercase hex string:

  • version_id: 1 byte, currently must be zero - hex encoded (2 characters)
  • trace_id: 16 bytes (opaque blob) - hex encoded (32 characters)
  • span_id: 8 bytes (opaque blob) - hex encoded (16 characters)
  • trace_options: 1 byte (LSB means tracing enabled) - hex encoded (2 characters) Example: "00-404142434445464748494a4b4c4d4e4f-6162636465666768-01" v trace_id span_id options
Property Value
Type Description
string

Type

public PacketType Type { get; set; }

Input only. Immutable. The type of the payload.

Property Value
Type Description
PacketType