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 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 String	api()	Api name for the request
abstract String	apiVersion()	Api version of the request
abstract GoPluginIdentifier	pluginIdentifier()	Provides an instance of GoPluginIdentifier for the request
abstract String	requestBody()	Provides json formatted request body
abstract Map<String,String>	requestHeaders()	Provides request headers as key value pair for the request.
abstract Map<String,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 String api()

Api name for the request

Returns:

api name

apiVersion

public abstract 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 Map<String,String> requestParameters()

Provides request parameters as key value pair for the request

Returns:

request parameters as a Map

requestHeaders

public abstract Map<String,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 String requestBody()

Provides json formatted request body

Returns:

request body