flv-api-spu 0.1.0

Fluvio API for SPU
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

//!
//! # Fetch Local SPU
//!
//! Public API to fetch local SPU metadata from the SPU
//!
use kf_protocol::api::Request;
use kf_protocol::derive::Decode;
use kf_protocol::derive::Encode;

use crate::SpuApiKey;
use crate::errors::FlvErrorCode;

// -----------------------------------
// FlvFetchLocalSpuRequest
// -----------------------------------

#[derive(Decode, Encode, Default, Debug)]
pub struct FlvFetchLocalSpuRequest {}

// -----------------------------------
// FlvFetchLocalSpuResponse
// -----------------------------------

#[derive(Encode, Decode, Default, Debug)]
pub struct FlvFetchLocalSpuResponse {
    /// Spu lookup error code, None for no error
    pub error_code: FlvErrorCode,

    /// Spu name. A unique key in Key/Value stores such as Kubernetes.
    pub name: String,

    /// Spu id. Managed Spu ids start from 0. Custom SPU ids start from 5000.
    pub id: i32,

    /// Spu type: true for managed, false for custom.
    pub managed: bool,

    /// Public endpoint server interface.
    pub public_ep: EndPointMetadata,

    /// Private endpoint server interface.
    pub private_ep: EndPointMetadata,

    /// Rack label, optional parameter used by replica assignment algorithm.
    pub rack: Option<String>,
}

#[derive(Encode, Decode, Default, Debug)]
pub struct EndPointMetadata {
    /// Port of the endpoint
    pub port: u16,

    /// Host name of the endoint
    pub host: String,
}

// -----------------------------------
// Implementation - FlvFetchLocalSpuRequest
// -----------------------------------

impl Request for FlvFetchLocalSpuRequest {
    const API_KEY: u16 = SpuApiKey::FlvFetchLocalSpu as u16;
    const DEFAULT_API_VERSION: i16 = 0;
    type Response = FlvFetchLocalSpuResponse;
}