Struct RegisterInstanceInfo 

#[non_exhaustive]
pub struct RegisterInstanceInfo {
    pub gear: String,
    pub instance_id: String,
    pub grpc_services: Vec<(String, ServiceEndpoint)>,
    pub version: Option<String>,
    pub rest_endpoint: Option<ServiceEndpoint>,
    pub openapi_spec: Option<String>,
    pub labels: BTreeMap<String, String>,
}

Information for registering a new gear instance

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.

gear: String

Gear name

instance_id: String

Unique instance identifier

grpc_services: Vec<(String, ServiceEndpoint)>

Published gRPC services as (service name, endpoint) pairs (service names are unique per instance; ordered to mirror the proto repeated field rather than reordered into a map).

version: Option<String>

Optional version string

rest_endpoint: Option<ServiceEndpoint>

Optional REST endpoint (HTTP base URL) exposed by the gear.

openapi_spec: Option<String>

Optional OpenAPI spec (JSON) published by the gear.

labels: BTreeMap<String, String>

Stable addressing labels for this instance (k8s matchLabels style).

Implementations

impl RegisterInstanceInfo

pub fn new( gear: impl Into<String>, instance_id: impl Into<String>, ) -> RegisterInstanceInfo

Start a registration for gear / instance_id with no endpoints, version, spec, or labels. Chain the with_* builders to populate it.

pub fn with_grpc_services( self, grpc_services: Vec<(String, ServiceEndpoint)>, ) -> RegisterInstanceInfo

Set the published gRPC services.

pub fn with_version(self, version: impl Into<String>) -> RegisterInstanceInfo

Set the version string.

pub fn with_rest_endpoint( self, rest_endpoint: ServiceEndpoint, ) -> RegisterInstanceInfo

Set the REST endpoint (HTTP base URL).

pub fn with_openapi_spec( self, openapi_spec: impl Into<String>, ) -> RegisterInstanceInfo

Set the published OpenAPI spec (JSON).

pub fn with_labels( self, labels: BTreeMap<String, String>, ) -> RegisterInstanceInfo

Set the stable addressing labels.

Re-registration replaces the directory entry wholesale, but an empty label set is treated as “preserve the stored labels”, not “clear them” (see GearManager::with_metadata_of): the periodic self-heal and REST augmentation re-register without labels and must not erase a shard’s identity. A non-empty set replaces the stored one. Clearing labels outright is therefore intentionally not expressible — an instance’s labels are its static shard/peer identity for its lifetime; changing them means restarting with new configuration.

Trait Implementations

impl Clone for RegisterInstanceInfo

fn clone(&self) -> RegisterInstanceInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterInstanceInfo

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

Formats the value using the given formatter.

impl Default for RegisterInstanceInfo

fn default() -> RegisterInstanceInfo

Returns the “default value” for a type.