Struct ExportKeyRequest

pub struct ExportKeyRequest {
    pub mount: String,
    pub key_type: ExportKeyType,
    pub name: String,
    pub version: ExportVersion,
}

Export Key

This endpoint returns the named key. The keys object shows the value of the key for each version. If version is specified, the specific version will be returned. If latest is provided as the version, the current key will be provided. Depending on the type of key, different information may be returned. The key must be exportable to support this operation and the version must still be valid.

• Path: {self.mount}/export/{self.key_type}/{self.name}(/{self.version})
• Method: GET
• Response: ExportKeyResponse
• Reference: https://developer.hashicorp.com/vault/api-docs/secret/transit#export-key

Fields

mount: String

key_type: ExportKeyType

name: String

version: ExportVersion

Implementations

impl ExportKeyRequest

pub fn builder() -> ExportKeyRequestBuilder

Trait Implementations

impl Debug for ExportKeyRequest

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

Formats the value using the given formatter.

impl Default for ExportKeyRequest

fn default() -> ExportKeyRequest

Returns the “default value” for a type.

impl Endpoint for ExportKeyRequest

const REQUEST_BODY_TYPE: RequestType = RequestType::JSON

The content type of the request body

const RESPONSE_BODY_TYPE: ResponseType = ResponseType::JSON

The content type of the response body

type Response = ExportKeyResponse

The type that the raw response from executing this endpoint will deserialized into. This type is passed on to the EndpointResult and is used to determine the type returned when the parse() method is called.

fn path(&self) -> String

The relative URL path that represents the location of this Endpoint. This is combined with the base URL from a Client instance to create the fully qualified URL.

fn method(&self) -> RequestMethod

The HTTP method to be used when executing this Endpoint.

fn query(&self) -> Result<Option<String>, ClientError>

Optional query parameters to add to the request.

fn body(&self) -> Result<Option<Vec<u8>>, ClientError>

Optional data to add to the body of the request.

fn url(&self, base: &str) -> Result<Uri, ClientError>

Returns the full URL address of the endpoint using the base address.

fn request(&self, base: &str) -> Result<Request<Vec<u8>>, ClientError>

Returns a Request containing all data necessary to execute against this endpoint.

fn exec<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 (impl Client + 'async_trait), ) -> Pin<Box<dyn Future<Output = Result<EndpointResult<Self::Response>, ClientError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Executes the Endpoint using the given Client.

fn with_middleware<M>(self, middleware: &M) -> MutatedEndpoint<'_, Self, M>

where M: MiddleWare,