Struct kafka_protocol::messages::get_telemetry_subscriptions_response::GetTelemetrySubscriptionsResponse

#[non_exhaustive]
pub struct GetTelemetrySubscriptionsResponse {
    pub throttle_time_ms: i32,
    pub error_code: i16,
    pub client_instance_id: Uuid,
    pub subscription_id: i32,
    pub accepted_compression_types: Vec<i8>,
    pub push_interval_ms: i32,
    pub telemetry_max_bytes: i32,
    pub delta_temporality: bool,
    pub requested_metrics: Vec<StrBytes>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

throttle_time_ms: i32

The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota.

Supported API versions: 0

error_code: i16

The error code, or 0 if there was no error.

Supported API versions: 0

client_instance_id: Uuid

Assigned client instance id if ClientInstanceId was 0 in the request, else 0.

Supported API versions: 0

subscription_id: i32

Unique identifier for the current subscription set for this client instance.

Supported API versions: 0

accepted_compression_types: Vec<i8>

Compression types that broker accepts for the PushTelemetryRequest.

Supported API versions: 0

push_interval_ms: i32

Configured push interval, which is the lowest configured interval in the current subscription set.

Supported API versions: 0

telemetry_max_bytes: i32

The maximum bytes of binary data the broker accepts in PushTelemetryRequest.

Supported API versions: 0

delta_temporality: bool

Flag to indicate monotonic/counter metrics are to be emitted as deltas or cumulative values

Supported API versions: 0

requested_metrics: Vec<StrBytes>

Requested metrics prefix string match. Empty array: No metrics subscribed, Array[0] empty string: All metrics subscribed.

Supported API versions: 0

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl GetTelemetrySubscriptionsResponse

pub fn with_throttle_time_ms(self, value: i32) -> Self

Sets throttle_time_ms to the passed value.

The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota.

Supported API versions: 0

pub fn with_error_code(self, value: i16) -> Self

Sets error_code to the passed value.

The error code, or 0 if there was no error.

Supported API versions: 0

pub fn with_client_instance_id(self, value: Uuid) -> Self

Sets client_instance_id to the passed value.

Assigned client instance id if ClientInstanceId was 0 in the request, else 0.

Supported API versions: 0

pub fn with_subscription_id(self, value: i32) -> Self

Sets subscription_id to the passed value.

Unique identifier for the current subscription set for this client instance.

Supported API versions: 0

pub fn with_accepted_compression_types(self, value: Vec<i8>) -> Self

Sets accepted_compression_types to the passed value.

Compression types that broker accepts for the PushTelemetryRequest.

Supported API versions: 0

pub fn with_push_interval_ms(self, value: i32) -> Self

Sets push_interval_ms to the passed value.

Configured push interval, which is the lowest configured interval in the current subscription set.

Supported API versions: 0

pub fn with_telemetry_max_bytes(self, value: i32) -> Self

Sets telemetry_max_bytes to the passed value.

The maximum bytes of binary data the broker accepts in PushTelemetryRequest.

Supported API versions: 0

pub fn with_delta_temporality(self, value: bool) -> Self

Sets delta_temporality to the passed value.

Flag to indicate monotonic/counter metrics are to be emitted as deltas or cumulative values

Supported API versions: 0

pub fn with_requested_metrics(self, value: Vec<StrBytes>) -> Self

Sets requested_metrics to the passed value.

Requested metrics prefix string match. Empty array: No metrics subscribed, Array[0] empty string: All metrics subscribed.

Supported API versions: 0

pub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self

Sets unknown_tagged_fields to the passed value.

pub fn with_unknown_tagged_field(self, key: i32, value: Bytes) -> Self

Inserts an entry into unknown_tagged_fields.

Trait Implementations

impl Clone for GetTelemetrySubscriptionsResponse

fn clone(&self) -> GetTelemetrySubscriptionsResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetTelemetrySubscriptionsResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decodable for GetTelemetrySubscriptionsResponse

fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self>

Decode the message from the provided buffer and version.

impl Default for GetTelemetrySubscriptionsResponse

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for GetTelemetrySubscriptionsResponse

fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()>

Encode the message into the target buffer.

fn compute_size(&self, version: i16) -> Result<usize>

Compute the total size of the message when encoded.

impl From<GetTelemetrySubscriptionsResponse> for ResponseKind

fn from(value: GetTelemetrySubscriptionsResponse) -> ResponseKind

Converts to this type from the input type.

impl HeaderVersion for GetTelemetrySubscriptionsResponse

fn header_version(version: i16) -> i16

Maps a header version to a given version for a particular API message.

impl Message for GetTelemetrySubscriptionsResponse

const VERSIONS: VersionRange = _

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for GetTelemetrySubscriptionsResponse

fn eq(&self, other: &GetTelemetrySubscriptionsResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetTelemetrySubscriptionsResponse