Struct taskcluster::Secrets
source · [−]pub struct Secrets {
pub client: Client,
}
Expand description
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.
Fields
client: Client
The underlying client used to make API calls for this service.
Implementations
Create a new Secrets instance, based on the given client builder
Ping Server
Respond without doing anything. This endpoint is used to check that the service is up.
Generate a signed URL for the ping endpoint
Set Secret
Set the secret associated with some key. If the secret already exists, it is updated instead.
Delete Secret
Delete the secret associated with some key. It will succeed whether or not the secret exists
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.
Generate an unsigned URL for the get endpoint
Generate a signed URL for the get endpoint
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.
Generate an unsigned URL for the list endpoint
Auto Trait Implementations
impl !RefUnwindSafe for Secrets
impl !UnwindSafe for Secrets
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more