public interface ServiceRequest extends OutgoingMessage
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getMethod()
Returns the HTTP method to be used for outbound service request only if one was explicitly set via setMethod()
|
java.lang.String |
getOrDefaultMethod()
Returns the HTTP method to be used for outbound service request which was either set set explicitly or passed through from API request
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getOrDefaultQueryParams()
Returns query parameters to be used for outbound service request.
|
java.lang.String |
getPathInfo()
Returns the path info - the resource part of the url.
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getQueryParams()
Returns query parameters to be used for outbound service request in a map keyed by parameter name
|
java.lang.String |
getRequestURL()
Returns the URL to be used for outbound service request
|
java.lang.String |
getService() |
java.lang.String |
getServiceAccount() |
boolean |
isUseProxy() |
ServiceRequest |
setMethod(java.lang.String method)
Sets the HTTP method string to be used for outbound request.
|
ServiceRequest |
setPathInfo(java.lang.String pathInfo)
Sets the path info to add additional strings to the request Url, without touching the request URL.
|
ServiceRequest |
setQueryParam(java.lang.String name, java.lang.String value)
Sets a single query parameter to be used for outbound service request to a given value
|
ServiceRequest |
setQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)
Sets the entire set of query parameters to be used for outbound request in a map keyed by parameter name
|
ServiceRequest |
setRequestURL(java.lang.String url)
Sets the request url to the given value
|
ServiceRequest |
setService(java.lang.String id)
Sets the service object to be associated with outbound service request
|
ServiceRequest |
setServiceAccount(java.lang.String id)
Sets the service account to be associated with outbound service request The account may be basic auth or OAuth
|
ServiceRequest |
useProxy(boolean useProxy)
Tells the runtime engine whether to use configured gateway node proxy server for outbound request
|
ServiceRequest |
withoutQueryParam(java.lang.String name)
Send the message without this query parameter.
|
getOrDefaultBody, getOrDefaultHeaders, setBody, setHeader, setHeaders, withoutHeader
getBody, getHeader, getHeaders
java.lang.String getMethod()
ServiceRequest setMethod(java.lang.String method)
method
- string, e.g. GETServiceRequest
instancejava.lang.String getOrDefaultMethod()
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getQueryParams()
ServiceRequest setQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)
map
- query parameter mapServiceRequest
instanceServiceRequest setQueryParam(java.lang.String name, java.lang.String value)
name
- parameter namevalue
- parameter valueServiceRequest
instancejava.lang.String getPathInfo()
ServiceRequest setPathInfo(java.lang.String pathInfo) throws java.io.IOException
pathInfo
- path info string, e.g. "/foo/bar"ServiceRequest
instancejava.io.IOException
- if an error occurs while setting the path infoServiceRequest setRequestURL(java.lang.String url) throws java.io.IOException
url
- url stringServiceRequest
instancejava.io.IOException
- if an error occurs while setting the URLjava.lang.String getRequestURL()
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getOrDefaultQueryParams()
ServiceRequest withoutQueryParam(java.lang.String name)
name
- parameter nameServiceRequest
instancejava.lang.String getServiceAccount()
ServiceRequest setServiceAccount(java.lang.String id)
id
- account idServiceRequest
instancejava.lang.String getService()
ServiceRequest setService(java.lang.String id)
id
- service object idServiceRequest
instanceboolean isUseProxy()
ServiceRequest useProxy(boolean useProxy)
ServiceRequest
instance