Package org.azd.abstractions

Class RequestInformation

java.lang.Object
org.azd.abstractions.RequestInformation
public class RequestInformation extends Object
Internal class to construct the request parameters to call Azure DevOps API.

  • Field Details

    • requestMethod

      public RequestMethod requestMethod
      Represents the Http Request method. RequestMethod

    • accessTokenCredential

      public AccessTokenCredential accessTokenCredential
      Pass the AccessTokenCredential for authentication.

    • project

      public String project
      (Optional) Pass the project name.

    • area

      public String area
      Area represents the Azure DevOps service such as work item tracking, Git, etc.

    • locationId

      public String locationId
      The unique location id to identify the details of the API.

    • pathParameters

      public Map<String,Object> pathParameters
      Path parameters of the URL.

    • apiVersion

      public String apiVersion
      This is mandatory. Respective API version.

    • requestHeaders

      public RequestHeaders requestHeaders
      Represents the request headers to be passed with the request.

    • requestBody

      public Object requestBody
      Request body.

    • inputStream

      public InputStream inputStream
      Represents the request body.

    • body

      public HttpRequest.BodyPublisher body
      Required to construct the client request to call the API.

  • Constructor Details

    • RequestInformation

      public RequestInformation()
      Default.

  • Method Details

    • setBaseInstance

      public void setBaseInstance(String baseInstance)
      Sets the base url.
      Parameters:
      baseInstance - Pass the base instance. e.g., dev.azure.com.

    • setQueryParameters

      public void setQueryParameters(Object parameters)
      Sets the query parameters.
      Parameters:
      parameters - Query parameters.

    • setQueryParameter

      public void setQueryParameter(String name, Object value)
      Sets the query parameters.
      Parameters:
      name - Name or key of the parameter.
      value - Value for the Name or key.

    • setQueryParameters

      public void setQueryParameters(Map<String,Object> queryParameters)
      Sets the query parameters from given map.
      Parameters:
      queryParameters - Map of query parameters.

    • getRequestUri

      public URI getRequestUri()
      Returns the fully constructed request URL.
      Returns:
      Request URI. URI

    • setRequestUrl

      public void setRequestUrl(String requestUrl)
      Sets the request URL.
      Parameters:
      requestUrl - Request url string to set.