com.gettyimages.api.CustomRequest

Class CustomRequest

java.lang.Object

com.gettyimages.api.AbstractApiRequest

com.gettyimages.api.CustomRequest.CustomRequest

public class CustomRequest
extends AbstractApiRequest

Field Summary

Fields inherited from class com.gettyimages.api.AbstractApiRequest

baseUrl, body, credentials, headers, method, path, queryParams

Method Summary

Modifier and Type	Method and Description
String	executeAsync()
static CustomRequest	GetInstance(Credentials credentials, String baseUrl)
CustomRequest	withBody(org.apache.http.entity.ByteArrayEntity value)
CustomRequest	withBody(org.json.JSONObject value)
CustomRequest	withBody(String value)
CustomRequest	withHeader(String name, String value)
CustomRequest	withMethod(String value)
CustomRequest	withQueryParameters(Map value)
CustomRequest	withRoute(String value)

Methods inherited from class com.gettyimages.api.AbstractApiRequest

addAgeOfPeople, addArtists, addCollectionCodes, addCompositions, addEditorialSegments, addEditorialVideoTypes, addEntityUris, addEthnicity, addEventIds, addFileTypes, addFrameRates, addGraphicalStyles, addKeywordIds, addLicenseModels, addNumberOfPeople, addOrientations, addProductTypes, addResponseFields, addSpecificPeople

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

GetInstance

public static CustomRequest GetInstance(Credentials credentials,
                                        String baseUrl)

executeAsync

public String executeAsync()
                    throws SdkException

Overrides:

executeAsync in class AbstractApiRequest

Throws:

SdkException

withMethod

public CustomRequest withMethod(String value)

Parameters:

value - The type of HTTP method - GET, POST, PUT, or DELETE

Returns:

CustomRequest

withRoute

public CustomRequest withRoute(String value)

Parameters:

value - The route to append to "https://api.gettyimages.com/v3"

Returns:

CustomRequest

withQueryParameters

public CustomRequest withQueryParameters(Map value)

Parameters:

value - A Map of key value pairs where the key is the name of the parameter and the value is the associated value(s)

Returns:

CustomRequest

withHeader

public CustomRequest withHeader(String name,
                                String value)

Parameters:

name - The header field name

value - The value associated with the field

Returns:

CustomRequest

withBody

public CustomRequest withBody(org.json.JSONObject value)
                       throws Exception

Parameters:

value - A JSONObject to be passed as the body of the request

Returns:

CustomRequest

Throws:

Exception

withBody

public CustomRequest withBody(String value)
                       throws Exception

Parameters:

value - A String to be passed as the body of the request

Returns:

CustomRequest

Throws:

Exception

withBody

public CustomRequest withBody(org.apache.http.entity.ByteArrayEntity value)

Parameters:

value - A ByteArrayEntity to be passed as the body of the request

Returns:

CustomRequest