Struct EntitlementsBuilder 

pub struct EntitlementsBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S: State> EntitlementsBuilder<S>

pub fn build(self) -> Entitlements

where S: IsComplete,

Finish building and return the requested object

pub fn applications( self, value: Vec<ApplicationEntitlements>, ) -> EntitlementsBuilder<SetApplications<S>>

where S::Applications: IsUnset,

Required.

One entry per application on the asking machine.

An identity belongs to a machine, so an agent asks on behalf of the box and gets an answer for every workload on it. The flat fields above describe a single-application machine, which is every machine today; on a machine hosting several they are left at their defaults and this list is the answer.

pub fn certificates( self, value: Vec<HeldCertificate>, ) -> EntitlementsBuilder<SetCertificates<S>>

where S::Certificates: IsUnset,

Required.

The certificates Canopy holds for this server.

pub fn domains(self, value: Vec<String>) -> EntitlementsBuilder<SetDomains<S>>

where S::Domains: IsUnset,

Required.

The domains this server’s group controls. Any name at or beneath one of these is a name this server may act on — which is what lets an agent request a certificate before anything asks for one.

pub fn may_manage_dns( self, value: bool, ) -> EntitlementsBuilder<SetMayManageDns<S>>

where S::MayManageDns: IsUnset,

Required.

Whether this server may manage its own DNS records.

pub fn may_manage_tls( self, value: bool, ) -> EntitlementsBuilder<SetMayManageTls<S>>

where S::MayManageTls: IsUnset,

Required.

Whether this server may obtain its own TLS certificates.

pub fn paused(self, value: bool) -> EntitlementsBuilder<SetPaused<S>>

where S::Paused: IsUnset,

Required.

Whether Canopy is currently making no new changes on this server’s behalf. While true, requests are refused and an agent should wait.

pub fn registered_names( self, value: Vec<String>, ) -> EntitlementsBuilder<SetRegisteredNames<S>>

where S::RegisteredNames: IsUnset,

Required.

The names this server has registered addresses for.