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

Class GoPluginApiRequest

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

  • Constructor Summary

    Constructors
    Constructor Description
    GoPluginApiRequest()  

  • Method Summary

    Modifier and Type Method Description
    abstract java.lang.String extension()
    Extension name of the request
    abstract java.lang.String extensionVersion()
    Extension version of 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.lang.String requestName()
    Name or operation supported for an extension
    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

    • GoPluginApiRequest

      public GoPluginApiRequest()

  • Method Details

    • extension

      public abstract java.lang.String extension()
      Extension name of the request
      Returns:
      extension name

    • extensionVersion

      public abstract java.lang.String extensionVersion()
      Extension version of the request
      Returns:
      extension version

    • requestName

      public abstract java.lang.String requestName()
      Name or operation supported for an extension
      Returns:
      name of the request

    • requestParameters

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

    • 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:
      map of request headers

    • requestBody

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