public final class PacketHeader extends GeneratedMessageV3 implements PacketHeaderOrBuilder
The message that represents packet header.
Protobuf type google.cloud.visionai.v1.PacketHeader
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CAPTURE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FLAGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SERIES_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SERVER_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TRACE_CONTEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static PacketHeader getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static PacketHeader.Builder newBuilder()
public static PacketHeader.Builder newBuilder(PacketHeader prototype)
public static PacketHeader parseDelimitedFrom(InputStream input)
public static PacketHeader parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PacketHeader parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static PacketHeader parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PacketHeader parseFrom(ByteString data)
public static PacketHeader parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PacketHeader parseFrom(CodedInputStream input)
public static PacketHeader parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PacketHeader parseFrom(InputStream input)
public static PacketHeader parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PacketHeader parseFrom(ByteBuffer data)
public static PacketHeader parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<PacketHeader> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public Timestamp getCaptureTime()
Input only. The capture time of the packet.
.google.protobuf.Timestamp capture_time = 1 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The captureTime.
|
public TimestampOrBuilder getCaptureTimeOrBuilder()
Input only. The capture time of the packet.
.google.protobuf.Timestamp capture_time = 1 [(.google.api.field_behavior) = INPUT_ONLY];
public PacketHeader getDefaultInstanceForType()
Immutable. Packet flag set. SDK will set the flag automatically.
int32 flags = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
int |
The flags.
|
public 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];
| Returns |
| Type |
Description |
Struct |
The metadata.
|
public 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];
public Parser<PacketHeader> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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];
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];
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];
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];
| Returns |
| Type |
Description |
String |
The traceContext.
|
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for traceContext.
|
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];
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];
public boolean hasCaptureTime()
Input only. The capture time of the packet.
.google.protobuf.Timestamp capture_time = 1 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the captureTime field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the metadata field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the seriesMetadata field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the serverMetadata field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the type field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public PacketHeader.Builder newBuilderForType()
protected PacketHeader.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public PacketHeader.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
