Class PacketHeader

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.PacketHeader
All Implemented Interfaces:
PacketHeaderOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class PacketHeader extends com.google.protobuf.GeneratedMessage implements PacketHeaderOrBuilder
 The message that represents packet header.
 
Protobuf type google.cloud.visionai.v1.PacketHeader
See Also:
  • Field Details

    • CAPTURE_TIME_FIELD_NUMBER

      public static final int CAPTURE_TIME_FIELD_NUMBER
      See Also:
    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:
    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:
    • SERVER_METADATA_FIELD_NUMBER

      public static final int SERVER_METADATA_FIELD_NUMBER
      See Also:
    • SERIES_METADATA_FIELD_NUMBER

      public static final int SERIES_METADATA_FIELD_NUMBER
      See Also:
    • FLAGS_FIELD_NUMBER

      public static final int FLAGS_FIELD_NUMBER
      See Also:
    • TRACE_CONTEXT_FIELD_NUMBER

      public static final int TRACE_CONTEXT_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • hasCaptureTime

      public boolean hasCaptureTime()
       Input only. The capture time of the packet.
       
      .google.protobuf.Timestamp capture_time = 1 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      hasCaptureTime in interface PacketHeaderOrBuilder
      Returns:
      Whether the captureTime field is set.
    • getCaptureTime

      public com.google.protobuf.Timestamp getCaptureTime()
       Input only. The capture time of the packet.
       
      .google.protobuf.Timestamp capture_time = 1 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getCaptureTime in interface PacketHeaderOrBuilder
      Returns:
      The captureTime.
    • getCaptureTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCaptureTimeOrBuilder()
       Input only. The capture time of the packet.
       
      .google.protobuf.Timestamp capture_time = 1 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getCaptureTimeOrBuilder in interface PacketHeaderOrBuilder
    • hasType

      public boolean hasType()
       Input only. Immutable. The type of the payload.
       
      .google.cloud.visionai.v1.PacketType type = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasType in interface PacketHeaderOrBuilder
      Returns:
      Whether the type field is set.
    • getType

      public PacketType getType()
       Input only. Immutable. The type of the payload.
       
      .google.cloud.visionai.v1.PacketType type = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getType in interface PacketHeaderOrBuilder
      Returns:
      The type.
    • getTypeOrBuilder

      public PacketTypeOrBuilder getTypeOrBuilder()
       Input only. Immutable. The type of the payload.
       
      .google.cloud.visionai.v1.PacketType type = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTypeOrBuilder in interface PacketHeaderOrBuilder
    • hasMetadata

      public boolean hasMetadata()
       Input only. This field is for users to attach user managed metadata.
       
      .google.protobuf.Struct metadata = 3 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      hasMetadata in interface PacketHeaderOrBuilder
      Returns:
      Whether the metadata field is set.
    • getMetadata

      public com.google.protobuf.Struct getMetadata()
       Input only. This field is for users to attach user managed metadata.
       
      .google.protobuf.Struct metadata = 3 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getMetadata in interface PacketHeaderOrBuilder
      Returns:
      The metadata.
    • getMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getMetadataOrBuilder()
       Input only. This field is for users to attach user managed metadata.
       
      .google.protobuf.Struct metadata = 3 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getMetadataOrBuilder in interface PacketHeaderOrBuilder
    • hasServerMetadata

      public boolean hasServerMetadata()
       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.
       
      .google.cloud.visionai.v1.ServerMetadata server_metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasServerMetadata in interface PacketHeaderOrBuilder
      Returns:
      Whether the serverMetadata field is set.
    • getServerMetadata

      public ServerMetadata getServerMetadata()
       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.
       
      .google.cloud.visionai.v1.ServerMetadata server_metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getServerMetadata in interface PacketHeaderOrBuilder
      Returns:
      The serverMetadata.
    • getServerMetadataOrBuilder

      public ServerMetadataOrBuilder getServerMetadataOrBuilder()
       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.
       
      .google.cloud.visionai.v1.ServerMetadata server_metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getServerMetadataOrBuilder in interface PacketHeaderOrBuilder
    • hasSeriesMetadata

      public boolean hasSeriesMetadata()
       Input only. Immutable. Metadata that the server needs to know where to
       write the packets to. It's only required for the first packet.
       
      .google.cloud.visionai.v1.SeriesMetadata series_metadata = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasSeriesMetadata in interface PacketHeaderOrBuilder
      Returns:
      Whether the seriesMetadata field is set.
    • getSeriesMetadata

      public SeriesMetadata getSeriesMetadata()
       Input only. Immutable. Metadata that the server needs to know where to
       write the packets to. It's only required for the first packet.
       
      .google.cloud.visionai.v1.SeriesMetadata series_metadata = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSeriesMetadata in interface PacketHeaderOrBuilder
      Returns:
      The seriesMetadata.
    • getSeriesMetadataOrBuilder

      public SeriesMetadataOrBuilder getSeriesMetadataOrBuilder()
       Input only. Immutable. Metadata that the server needs to know where to
       write the packets to. It's only required for the first packet.
       
      .google.cloud.visionai.v1.SeriesMetadata series_metadata = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSeriesMetadataOrBuilder in interface PacketHeaderOrBuilder
    • getFlags

      public int getFlags()
       Immutable. Packet flag set. SDK will set the flag automatically.
       
      int32 flags = 6 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getFlags in interface PacketHeaderOrBuilder
      Returns:
      The flags.
    • getTraceContext

      public String getTraceContext()
       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
       
      string trace_context = 7 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTraceContext in interface PacketHeaderOrBuilder
      Returns:
      The traceContext.
    • getTraceContextBytes

      public com.google.protobuf.ByteString getTraceContextBytes()
       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
       
      string trace_context = 7 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTraceContextBytes in interface PacketHeaderOrBuilder
      Returns:
      The bytes for traceContext.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static PacketHeader parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PacketHeader parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PacketHeader parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PacketHeader parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PacketHeader parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PacketHeader parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PacketHeader parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PacketHeader parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PacketHeader parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PacketHeader parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PacketHeader parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PacketHeader parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public PacketHeader.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static PacketHeader.Builder newBuilder()
    • newBuilder

      public static PacketHeader.Builder newBuilder(PacketHeader prototype)
    • toBuilder

      public PacketHeader.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected PacketHeader.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static PacketHeader getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<PacketHeader> parser()
    • getParserForType

      public com.google.protobuf.Parser<PacketHeader> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public PacketHeader getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder