Struct taskcluster::Secrets [−][src]
Secrets Service
The secrets service provides a simple key/value store for small bits of secret data. Access is limited by scopes, so values can be considered secret from those who do not have the relevant scopes.
Secrets also have an expiration date, and once a secret has expired it can no longer be read. This is useful for short-term secrets such as a temporary service credential or a one-time signing key.
Implementations
impl Secrets
[src]
pub fn new<CB: Into<ClientBuilder>>(client_builder: CB) -> Result<Self, Error>
[src]
Create a new undefined instance, based on the given client.
pub async fn ping(&self) -> Result<(), Error>
[src]
Ping Server
Respond without doing anything. This endpoint is used to check that the service is up.
pub fn ping_url(&self) -> Result<String, Error>
[src]
Generate an unsigned URL for the ping endpoint
pub fn ping_signed_url(&self, ttl: Duration) -> Result<String, Error>
[src]
Generate a signed URL for the ping endpoint
pub async fn set(&self, name: &str, payload: &Value) -> Result<(), Error>
[src]
Set Secret
Set the secret associated with some key. If the secret already exists, it is updated instead.
pub async fn remove(&self, name: &str) -> Result<(), Error>
[src]
Delete Secret
Delete the secret associated with some key. It will succeed whether or not the secret exists
pub async fn get(&self, name: &str) -> Result<Value, Error>
[src]
Read Secret
Read the secret associated with some key. If the secret has recently expired, the response code 410 is returned. If the caller lacks the scope necessary to get the secret, the call will fail with a 403 code regardless of whether the secret exists.
pub fn get_url(&self, name: &str) -> Result<String, Error>
[src]
Generate an unsigned URL for the get endpoint
pub fn get_signed_url(&self, name: &str, ttl: Duration) -> Result<String, Error>
[src]
Generate a signed URL for the get endpoint
pub async fn list(
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<Value, Error>
[src]
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<Value, Error>
List Secrets
List the names of all secrets.
By default this end-point will try to return up to 1000 secret names in one
request. But it may return less, even if more tasks are available.
It may also return a continuationToken
even though there are no more
results. However, you can only be sure to have seen all results if you
keep calling listTaskGroup
with the last continuationToken
until you
get a result without a continuationToken
.
If you are not interested in listing all the members at once, you may
use the query-string option limit
to return fewer.
pub fn list_url(
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<String, Error>
[src]
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<String, Error>
Generate an unsigned URL for the list endpoint
pub fn list_signed_url(
&self,
continuationToken: Option<&str>,
limit: Option<&str>,
ttl: Duration
) -> Result<String, Error>
[src]
&self,
continuationToken: Option<&str>,
limit: Option<&str>,
ttl: Duration
) -> Result<String, Error>
Generate a signed URL for the list endpoint
Auto Trait Implementations
impl !RefUnwindSafe for Secrets
[src]
impl Send for Secrets
[src]
impl Sync for Secrets
[src]
impl Unpin for Secrets
[src]
impl !UnwindSafe for Secrets
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,