| java.lang.Object | ||
| ↳ | com.microstrategy.webapi.restApi.RestClientBuilder | |
| ↳ | com.microstrategy.webapi.restApi.IServerRestClientBuilder | |
Class Overview
Builder pattern to build I-Server REST Client
Ex. Sample Code
GET API call
RestClient restClient = new IServerRestClientBuilder()
.sessionId(iServerSession.getSessionID())
.relativeUrl("/messages/B19DEDCC11D4E0EFC000EB9495D0F44F/bookmarks")
.methodTypes(MethodTypes.GET)
.build();
POST API call
RestClient restClient = new IServerRestClientBuilder()
.sessionId(iServerSession.getSessionID())
.relativeUrl("/messages/B19DEDCC11D4E0EFC000EB9495D0F44F/bookmarks")
.mediaType(MediaTypes.APPLICATION_JSON)
.body("{}")
.methodTypes(MethodTypes.POST)
.build();
Summary
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
com.microstrategy.webapi.restApi.RestClientBuilder
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| IServerRestClientBuilder() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| IServerRestClientBuilder |
addheader(String key, String value)
adds individual header key-value
| ||||||||||
| IServerRestClientBuilder | body(String body) | ||||||||||
| RestClient | build() | ||||||||||
| IServerRestClientBuilder |
connectTimeout(int connectTimeout)
Set http connect timeout
| ||||||||||
| IServerRestClientBuilder | headers(Map<String, List<String>> headers) | ||||||||||
| IServerRestClientBuilder |
mediaType(String mediaType)
Set media type using String value
| ||||||||||
| IServerRestClientBuilder |
mediaType(MediaTypes mediaType)
Set media type using Enum
| ||||||||||
| IServerRestClientBuilder | methodTypes(MethodTypes methodTypes) | ||||||||||
| IServerRestClientBuilder |
readTimeout(int readTimeout)
Set http read timeout
| ||||||||||
| IServerRestClientBuilder |
relativeUrl(String relativeUrl)
Provide a relative URL
| ||||||||||
| IServerRestClientBuilder |
sessionId(String sessionId)
Set the session ID
| ||||||||||
| String | toString() | ||||||||||
| IServerRestClientBuilder | url(String url) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.microstrategy.webapi.restApi.RestClientBuilder
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public IServerRestClientBuilder ()
Public Methods
public IServerRestClientBuilder addheader (String key, String value)
adds individual header key-value
public IServerRestClientBuilder mediaType (String mediaType)
Set media type using String value
Parameters
| mediaType | Any valid "accept" header value |
|---|