Struct vector_api_client::gql::HeartbeatSubscription

pub struct HeartbeatSubscription;

HeartbeatSubscription is a subscription that returns a ‘heartbeat’ in the form of a UTC timestamp. The use-case is allowing a client to assert that the server is sending regular payloads, by using the timestamp to determine when the last healthcheck was successful.

Trait Implementations

impl Clone for HeartbeatSubscription

fn clone(&self) -> HeartbeatSubscription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeartbeatSubscription

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

Formats the value using the given formatter.

impl GraphQLQuery for HeartbeatSubscription

type Variables = Variables

The shape of the variables expected by the query. This should be a generated struct most of the time.

type ResponseData = ResponseData

The top-level shape of the response data (the data field in the GraphQL response). In practice this should be generated, since it is hard to write by hand without error.

fn build_query(variables: Self::Variables) -> QueryBody<Self::Variables>

Produce a GraphQL query struct that can be JSON serialized and sent to a GraphQL API.

impl Copy for HeartbeatSubscription