Package com.google.cloud.functions

Interface HttpRequest

All Superinterfaces:
HttpMessage
public interface HttpRequest extends HttpMessage
Represents the contents of an HTTP request that is being serviced by a Cloud Function.

  • Method Details

    • getMethod

      String getMethod()
      The HTTP method of this request, such as "POST" or "GET".
      Returns:
      the HTTP method of this request.

    • getUri

      String getUri()
      The full URI of this request as it arrived at the server.
      Returns:
      the full URI of this request.

    • getPath

      String getPath()
      The path part of the URI for this request, without any query. If the full URI is http://foo.com/bar/baz?this=that, then this method will return /bar/baz.
      Returns:
      the path part of the URI for this request.

    • getQuery

      Optional<String> getQuery()
      The query part of the URI for this request. If the full URI is http://foo.com/bar/baz?this=that, then this method will return this=that. If there is no query part, the returned Optional is empty.
      Returns:
      the query part of the URI, if any.

    • getQueryParameters

      Map<String,List<String>> getQueryParameters()
      The query parameters of this request. If the full URI is http://foo.com/bar?thing=thing1&thing=thing2&cat=hat, then the returned map will map thing to the list ["thing1", "thing2"] and cat to the list with the single element "hat".
      Returns:
      a map where each key is the name of a query parameter and the corresponding List value indicates every value that was associated with that name.

    • getFirstQueryParameter

      default Optional<String> getFirstQueryParameter(String name)
      The first query parameter with the given name, if any. If the full URI is http://foo.com/bar?thing=thing1&thing=thing2&cat=hat, then getFirstQueryParameter("thing") will return Optional.of("thing1") and getFirstQueryParameter("something") will return Optional.empty(). This is a more convenient alternative to getQueryParameters().
      Parameters:
      name - a query parameter name.
      Returns:
      the first query parameter value with the given name, if any.

    • getParts

      Map<String,HttpRequest.HttpPart> getParts()
      Returns the parts inside this multipart (multipart/form-data) HTTP request. Each entry in the returned map has the name of the part as its key and the contents as the associated value.
      Returns:
      a map from part names to part contents.
      Throws:
      IllegalStateException - if the content type is not multipart/form-data.