FetchOptions (Box Java SDK)

Object
- FetchOptions

public class FetchOptions
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FetchOptions.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`FetchOptions.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`Authentication`	`auth` Authentication object
`String`	`contentType` Content type of the request body
`JsonNode`	`data` Request body of the request
`InputStream`	`fileStream` Stream data of the request
`Boolean`	`followRedirects` A boolean value indicate if the request should follow redirects.
`Map<String,String>`	`headers` HTTP headers
`String`	`method` HTTP verb of the request
`List<MultipartItem>`	`multipartData` Multipart data of the request
`NetworkSession`	`networkSession` Network session object
`Map<String,String>`	`params` HTTP query parameters
`EnumWrapper<ResponseFormat>`	`responseFormat` Expected response format
`String`	`url` URL of the request

Constructor Summary

Constructors
Modifier Constructor and Description

protected FetchOptions(FetchOptions.Builder builder)

FetchOptions(String url, String method)

Constructors
Modifier	Constructor and Description
`protected`	`FetchOptions(FetchOptions.Builder builder)`
	`FetchOptions(String url, String method)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authentication`	`getAuth()`
`String`	`getContentType()`
`JsonNode`	`getData()`
`InputStream`	`getFileStream()`
`Boolean`	`getFollowRedirects()`
`Map<String,String>`	`getHeaders()`
`String`	`getMethod()`
`List<MultipartItem>`	`getMultipartData()`
`NetworkSession`	`getNetworkSession()`
`Map<String,String>`	`getParams()`
`EnumWrapper<ResponseFormat>`	`getResponseFormat()`
`String`	`getUrl()`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- url
```
public final String url
```
  URL of the request
- method
```
public final String method
```
  HTTP verb of the request
- params
```
public Map<String,String> params
```
  HTTP query parameters
- headers
```
public Map<String,String> headers
```
  HTTP headers
- data
```
public JsonNode data
```
  Request body of the request
- fileStream
```
public InputStream fileStream
```
  Stream data of the request
- multipartData
```
public List<MultipartItem> multipartData
```
  Multipart data of the request
- contentType
```
public String contentType
```
  Content type of the request body
- responseFormat
```
public EnumWrapper<ResponseFormat> responseFormat
```
  Expected response format
- auth
```
public Authentication auth
```
  Authentication object
- networkSession
```
public NetworkSession networkSession
```
  Network session object
- followRedirects
```
public Boolean followRedirects
```
  A boolean value indicate if the request should follow redirects. Defaults to True. Not supported in Browser environment.

Constructor Detail

FetchOptions

public FetchOptions(String url,
                    String method)

FetchOptions

protected FetchOptions(FetchOptions.Builder builder)

Method Detail

getUrl
```
public String getUrl()
```

getMethod
```
public String getMethod()
```

getParams
```
public Map<String,String> getParams()
```

getHeaders

public Map<String,String> getHeaders()

getData
```
public JsonNode getData()
```

getFileStream
```
public InputStream getFileStream()
```

getMultipartData

public List<MultipartItem> getMultipartData()

getContentType
```
public String getContentType()
```

getResponseFormat

public EnumWrapper<ResponseFormat> getResponseFormat()

getAuth
```
public Authentication getAuth()
```

getNetworkSession

public NetworkSession getNetworkSession()

getFollowRedirects
```
public Boolean getFollowRedirects()
```

Class FetchOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

url

method

params

headers

data

fileStream

multipartData

contentType

responseFormat

auth

networkSession

followRedirects

Constructor Detail

FetchOptions

FetchOptions

Method Detail

getUrl

getMethod

getParams

getHeaders

getData

getFileStream

getMultipartData

getContentType

getResponseFormat

getAuth

getNetworkSession

getFollowRedirects