Interface VaultClient.PathSpec<S extends VaultClient.RequestHeadersSpec<?>>

Type Parameters:
S - a self reference to the spec type
All Known Subinterfaces:
VaultClient.RequestHeadersBodyPathSpec, VaultClient.RequestHeadersPathSpec<S>
Enclosing interface:
VaultClient
public static interface VaultClient.PathSpec<S extends VaultClient.RequestHeadersSpec<?>>
Contract for specifying the path for a request.
Since:
4.1
Author:
Mark Paluch

  • Method Summary

    Modifier and Type
    Method
    Description
    S
    path(String path, @Nullable Object... pathVariables)
    Specify the path for the request using a URI template and URI variables.
    S
    path(String path, Map<String, ? extends @Nullable Object> pathVariables)
    Specify the path for the request using a URI template and URI variables.
    S
    uri(URI uri)
    Specify the URI using a fully constructed URI.

  • Method Details

    • path

      S path(String path, @Nullable Object... pathVariables)
      Specify the path for the request using a URI template and URI variables.

      If a VaultEndpointProvider or UriBuilderFactory was configured for the client (for example, with a base URI) this method will use these to create a base URI and prevent usage of absolute URIs to avoid unwanted access to servers other than the VaultEndpoint.

    • path

      S path(String path, Map<String, ? extends @Nullable Object> pathVariables)
      Specify the path for the request using a URI template and URI variables.

      If a VaultEndpointProvider or UriBuilderFactory was configured for the client (for example, with a base URI) this method will use these to create a base URI and prevent usage of absolute URIs to avoid unwanted access to servers other than the VaultEndpoint.

    • uri

      S uri(URI uri)
      Specify the URI using a fully constructed URI.

      If the given URI is absolute, it is used as given. If it is a relative URI, the UriBuilderFactory configured for the client (for example, with a base URI) will be used to resolve the given URI against.