Package com.thoughtworks.go.plugin.api.request

Class GoApiRequest

java.lang.Object
com.thoughtworks.go.plugin.api.request.GoApiRequest
Direct Known Subclasses:
DefaultGoApiRequest
public abstract class GoApiRequest
extends java.lang.Object
Provides an abstraction for api request sent from plugin to Go

  • Constructor Summary

    Constructors
    Constructor Description
    GoApiRequest()  

  • Method Summary

    Modifier and Type Method Description
    abstract java.lang.String api()
    Api name for the request
    abstract java.lang.String apiVersion()
    Api version of the request
    abstract GoPluginIdentifier pluginIdentifier()
    Provides an instance of GoPluginIdentifier for the request
    abstract java.lang.String requestBody()
    Provides json formatted request body
    abstract java.util.Map<java.lang.String,​java.lang.String> requestHeaders()
    Provides request headers as key value pair for the request.
    abstract java.util.Map<java.lang.String,​java.lang.String> requestParameters()
    Provides request parameters as key value pair for the request

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GoApiRequest

      public GoApiRequest()

  • Method Details

    • api

      public abstract java.lang.String api()
      Api name for the request
      Returns:
      api name

    • apiVersion

      public abstract java.lang.String apiVersion()
      Api version of the request
      Returns:
      api version

    • pluginIdentifier

      public abstract GoPluginIdentifier pluginIdentifier()
      Provides an instance of GoPluginIdentifier for the request
      Returns:
      an instance of GoPluginIdentifier

    • requestParameters

      public abstract java.util.Map<java.lang.String,​java.lang.String> requestParameters()
      Provides request parameters as key value pair for the request
      Returns:
      request parameters as a Map

    • requestHeaders

      public abstract java.util.Map<java.lang.String,​java.lang.String> requestHeaders()
      Provides request headers as key value pair for the request. Request headers can be used to send any meta information related to request
      Returns:
      request headers as a Map

    • requestBody

      public abstract java.lang.String requestBody()
      Provides json formatted request body
      Returns:
      request body