com.google.cloud.visionai.v1.PacketHeaderOrBuilder Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/visionai/v1/streaming_resources.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.visionai.v1;
public interface PacketHeaderOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.PacketHeader)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Input only. The capture time of the packet.
*
*
* .google.protobuf.Timestamp capture_time = 1 [(.google.api.field_behavior) = INPUT_ONLY];
*
*
* @return Whether the captureTime field is set.
*/
boolean hasCaptureTime();
/**
*
*
*
* Input only. The capture time of the packet.
*
*
* .google.protobuf.Timestamp capture_time = 1 [(.google.api.field_behavior) = INPUT_ONLY];
*
*
* @return The captureTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCaptureTimeOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the type field is set.
*/
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];
*
*
* @return The type.
*/
com.google.cloud.visionai.v1.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];
*
*/
com.google.cloud.visionai.v1.PacketTypeOrBuilder getTypeOrBuilder();
/**
*
*
*
* Input only. This field is for users to attach user managed metadata.
*
*
* .google.protobuf.Struct metadata = 3 [(.google.api.field_behavior) = INPUT_ONLY];
*
* @return Whether the metadata field is set.
*/
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];
*
* @return The metadata.
*/
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];
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the serverMetadata field is set.
*/
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];
*
*
* @return The serverMetadata.
*/
com.google.cloud.visionai.v1.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];
*
*/
com.google.cloud.visionai.v1.ServerMetadataOrBuilder getServerMetadataOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the seriesMetadata field is set.
*/
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];
*
*
* @return The seriesMetadata.
*/
com.google.cloud.visionai.v1.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];
*
*/
com.google.cloud.visionai.v1.SeriesMetadataOrBuilder getSeriesMetadataOrBuilder();
/**
*
*
*
* Immutable. Packet flag set. SDK will set the flag automatically.
*
*
* int32 flags = 6 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The flags.
*/
int getFlags();
/**
*
*
*
* 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];
*
* @return The traceContext.
*/
java.lang.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];
*
* @return The bytes for traceContext.
*/
com.google.protobuf.ByteString getTraceContextBytes();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy