Interface Endpoint

  • All Known Implementing Classes:
    HttpEndpoint

    public interface Endpoint
    An endpoint in a Vespa application Deployment, which allows document retrieval.
    Author:
    jonmv
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default java.net.http.HttpRequest.Builder request​(java.lang.String path)
      Creates a request against the endpoint, with the given path.
      java.net.http.HttpRequest.Builder request​(java.lang.String path, java.util.Map<java.lang.String,​java.lang.String> properties)
      Creates a request against the endpoint, with the given path and properties.
      default java.net.http.HttpResponse<java.lang.String> send​(java.net.http.HttpRequest.Builder request)
      Sends the given request with required authentication.
      <T> java.net.http.HttpResponse<T> send​(java.net.http.HttpRequest.Builder request, java.net.http.HttpResponse.BodyHandler<T> handler)
      Sends the given request with required authentication.
      java.net.URI uri()
      Returns the URI of the endpoint, with scheme, host and port.
    • Method Detail

      • uri

        java.net.URI uri()
        Returns the URI of the endpoint, with scheme, host and port.
      • send

        <T> java.net.http.HttpResponse<T> send​(java.net.http.HttpRequest.Builder request,
                                               java.net.http.HttpResponse.BodyHandler<T> handler)
        Sends the given request with required authentication. See EndpointAuthenticator.authenticated(java.net.http.HttpRequest.Builder) and HttpClient.send(java.net.http.HttpRequest, java.net.http.HttpResponse.BodyHandler<T>).
      • send

        default java.net.http.HttpResponse<java.lang.String> send​(java.net.http.HttpRequest.Builder request)
        Sends the given request with required authentication.
      • request

        java.net.http.HttpRequest.Builder request​(java.lang.String path,
                                                  java.util.Map<java.lang.String,​java.lang.String> properties)
        Creates a request against the endpoint, with the given path and properties.
      • request

        default java.net.http.HttpRequest.Builder request​(java.lang.String path)
        Creates a request against the endpoint, with the given path.