Class: Google::Cloud::VisionAI::V1::PacketHeader

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/streaming_resources.rb

Overview

The message that represents packet header.

Instance Attribute Summary collapse

Instance Attribute Details

#capture_time ⇒ ::Google::Protobuf::Timestamp

Returns Input only. The capture time of the packet.

Returns:



159
160
161
162
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_resources.rb', line 159

class PacketHeader
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#flags ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



159
160
161
162
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_resources.rb', line 159

class PacketHeader
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metadata ⇒ ::Google::Protobuf::Struct

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

Returns:



159
160
161
162
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_resources.rb', line 159

class PacketHeader
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#series_metadata ⇒ ::Google::Cloud::VisionAI::V1::SeriesMetadata

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

Returns:



159
160
161
162
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_resources.rb', line 159

class PacketHeader
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#server_metadata ⇒ ::Google::Cloud::VisionAI::V1::ServerMetadata (readonly)

Returns 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.

Returns:



159
160
161
162
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_resources.rb', line 159

class PacketHeader
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#trace_context ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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


159
160
161
162
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_resources.rb', line 159

class PacketHeader
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::Google::Cloud::VisionAI::V1::PacketType

Returns Input only. Immutable. The type of the payload.

Returns:



159
160
161
162
 
# File 'proto_docs/google/cloud/visionai/v1/streaming_resources.rb', line 159

class PacketHeader
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end