ApiRequestBuilder (platform-client-v2 255.0.0 API)

java.lang.Object

com.mypurecloud.sdk.v2.ApiRequestBuilder<T>

public class ApiRequestBuilder<T> extends Object

Method Summary

Modifier and Type

Method

Description

ApiRequest<T>

build()

static ApiRequestBuilder<Void>

create(String method, String path)

static String

formatDate(Date date)

Format the given Date object into string.

static DateFormat

getDateFormat()

static void

setDateFormat(DateFormat dateFormat)

ApiRequestBuilder<T>

withAccepts(String... accepts)

ApiRequestBuilder<T>

withAuthNames(String... authNames)

<BODY> ApiRequestBuilder<BODY>

withBody(BODY body)

ApiRequestBuilder<T>

withContentTypes(String... contentTypes)

ApiRequestBuilder<T>

withCustomHeader(String name, String value)

ApiRequestBuilder<T>

withCustomHeaders(Map<String,String> headers)

ApiRequestBuilder<T>

withFormParameter(String name, Object value)

ApiRequestBuilder<T>

withHeaderParameter(String name, Object value)

ApiRequestBuilder<T>

withPathParameter(String name, Object value)

ApiRequestBuilder<T>

withQueryParameters(String name, String collectionFormat, Object value)

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

Method Details
- setDateFormat
  
  public static void setDateFormat(DateFormat dateFormat)
- getDateFormat
  
  public static DateFormat getDateFormat()
- formatDate
  
  public static String formatDate(Date date)
  
  Format the given Date object into string.
- create
  
  public static ApiRequestBuilder<Void> create(String method, String path)
- withPathParameter
  
  public ApiRequestBuilder<T> withPathParameter(String name, Object value)
- withFormParameter
  
  public ApiRequestBuilder<T> withFormParameter(String name, Object value)
- withQueryParameters
  
  public ApiRequestBuilder<T> withQueryParameters(String name, String collectionFormat, Object value)
- withHeaderParameter
  
  public ApiRequestBuilder<T> withHeaderParameter(String name, Object value)
- withCustomHeader
  
  public ApiRequestBuilder<T> withCustomHeader(String name, String value)
- withCustomHeaders
  
  public ApiRequestBuilder<T> withCustomHeaders(Map<String,String> headers)
- withContentTypes
  
  public ApiRequestBuilder<T> withContentTypes(String... contentTypes)
- withAccepts
  
  public ApiRequestBuilder<T> withAccepts(String... accepts)
- withAuthNames
  
  public ApiRequestBuilder<T> withAuthNames(String... authNames)
- withBody
  
  public <BODY> ApiRequestBuilder<BODY> withBody(BODY body)
- build
  
  public ApiRequest<T> build()