public interface RestClient
Modifier and Type | Interface and Description |
---|---|
static interface |
RestClient.ResponseCallback |
Modifier and Type | Method and Description |
---|---|
void |
apexCall(String httpMethod,
String apexUrl,
Map<String,Object> queryParams,
InputStream requestDto,
RestClient.ResponseCallback callback)
Executes a user defined APEX REST API call.
|
void |
createSObject(String sObjectName,
InputStream sObject,
RestClient.ResponseCallback callback)
Creates a record for the specified object.
|
void |
deleteSObject(String sObjectName,
String id,
RestClient.ResponseCallback callback)
Deletes a record for the specified object ID.
|
void |
deleteSObjectWithId(String sObjectName,
String fieldName,
String fieldValue,
RestClient.ResponseCallback callback)
Deletes a record based on the value of a specified external ID field.
|
void |
getBasicInfo(String sObjectName,
RestClient.ResponseCallback callback)
Describes the individual metadata for the specified object.
|
void |
getBlobField(String sObjectName,
String id,
String blobFieldName,
RestClient.ResponseCallback callback)
Retrieves the specified blob field from an individual record.
|
void |
getDescription(String sObjectName,
RestClient.ResponseCallback callback)
Completely describes the individual metadata at all levels for the specified object.
|
void |
getGlobalObjects(RestClient.ResponseCallback callback)
Lists the available objects and their metadata for your organization's data.
|
void |
getResources(RestClient.ResponseCallback callback)
Lists available resources for the specified API version, including resource name and URI.
|
void |
getSObject(String sObjectName,
String id,
String[] fields,
RestClient.ResponseCallback callback)
Retrieves a record for the specified object ID.
|
void |
getSObjectWithId(String sObjectName,
String fieldName,
String fieldValue,
RestClient.ResponseCallback callback)
Retrieves a record for the specified external ID.
|
void |
getVersions(RestClient.ResponseCallback callback)
Lists summary information about each API version currently available,
including the version, label, and a link to each version's root.
|
void |
limits(RestClient.ResponseCallback responseCallback)
Fetches Organization Limits.
|
void |
query(String soqlQuery,
RestClient.ResponseCallback callback)
Executes the specified SOQL query.
|
void |
queryAll(String soqlQuery,
RestClient.ResponseCallback callback)
Executes the specified SOQL query including deleted records.
|
void |
queryMore(String nextRecordsUrl,
RestClient.ResponseCallback callback)
Get SOQL query results using nextRecordsUrl.
|
void |
search(String soslQuery,
RestClient.ResponseCallback callback)
Executes the specified SOSL search.
|
void |
updateSObject(String sObjectName,
String id,
InputStream sObject,
RestClient.ResponseCallback callback)
Updates a record for the specified object ID.
|
void |
upsertSObject(String sObjectName,
String fieldName,
String fieldValue,
InputStream sObject,
RestClient.ResponseCallback callback)
Creates or updates a record based on the value of a specified external ID field.
|
void getVersions(RestClient.ResponseCallback callback)
callback
- RestClient.ResponseCallback
to handle response or exceptionvoid getResources(RestClient.ResponseCallback callback)
callback
- RestClient.ResponseCallback
to handle response or exceptionvoid getGlobalObjects(RestClient.ResponseCallback callback)
callback
- RestClient.ResponseCallback
to handle response or exceptionvoid getBasicInfo(String sObjectName, RestClient.ResponseCallback callback)
sObjectName
- specified object namecallback
- RestClient.ResponseCallback
to handle response or exceptionvoid getDescription(String sObjectName, RestClient.ResponseCallback callback)
sObjectName
- specified object namecallback
- RestClient.ResponseCallback
to handle response or exceptionvoid getSObject(String sObjectName, String id, String[] fields, RestClient.ResponseCallback callback)
sObjectName
- specified object nameid
- object idcallback
- RestClient.ResponseCallback
to handle response or exceptionvoid createSObject(String sObjectName, InputStream sObject, RestClient.ResponseCallback callback)
sObjectName
- specified object namesObject
- request entitycallback
- RestClient.ResponseCallback
to handle response or exceptionvoid updateSObject(String sObjectName, String id, InputStream sObject, RestClient.ResponseCallback callback)
sObjectName
- specified object nameid
- object idsObject
- request entitycallback
- RestClient.ResponseCallback
to handle response or exceptionvoid deleteSObject(String sObjectName, String id, RestClient.ResponseCallback callback)
sObjectName
- specified object nameid
- object idcallback
- RestClient.ResponseCallback
to handle response or exceptionvoid getSObjectWithId(String sObjectName, String fieldName, String fieldValue, RestClient.ResponseCallback callback)
sObjectName
- specified object namefieldName
- external field namefieldValue
- external field valuecallback
- RestClient.ResponseCallback
to handle response or exceptionvoid upsertSObject(String sObjectName, String fieldName, String fieldValue, InputStream sObject, RestClient.ResponseCallback callback)
sObjectName
- specified object namefieldName
- external field namefieldValue
- external field valuesObject
- input object to insert or updatecallback
- RestClient.ResponseCallback
to handle response or exceptionvoid deleteSObjectWithId(String sObjectName, String fieldName, String fieldValue, RestClient.ResponseCallback callback)
sObjectName
- specified object namefieldName
- external field namefieldValue
- external field valuecallback
- RestClient.ResponseCallback
to handle response or exceptionvoid getBlobField(String sObjectName, String id, String blobFieldName, RestClient.ResponseCallback callback)
void query(String soqlQuery, RestClient.ResponseCallback callback)
soqlQuery
- SOQL querycallback
- RestClient.ResponseCallback
to handle response or exceptionvoid queryMore(String nextRecordsUrl, RestClient.ResponseCallback callback)
nextRecordsUrl
- URL for next records to fetch, returned by query()callback
- RestClient.ResponseCallback
to handle response or exceptionvoid queryAll(String soqlQuery, RestClient.ResponseCallback callback)
soqlQuery
- SOQL querycallback
- RestClient.ResponseCallback
to handle response or exceptionvoid search(String soslQuery, RestClient.ResponseCallback callback)
soslQuery
- SOSL querycallback
- RestClient.ResponseCallback
to handle response or exceptionvoid apexCall(String httpMethod, String apexUrl, Map<String,Object> queryParams, InputStream requestDto, RestClient.ResponseCallback callback)
httpMethod
- HTTP method to execute.apexUrl
- APEX api url.queryParams
- optional query parameters for GET methods, may be empty.requestDto
- optional input DTO for POST, etc. may be null.callback
- RestClient.ResponseCallback
to handle response or exceptionvoid limits(RestClient.ResponseCallback responseCallback)
responseCallback
- RestClient.ResponseCallback
to handle response or exceptionApache Camel