org.mule.modules.marketo.api

Class CustomObjectsClientImpl

java.lang.Object

org.mule.modules.marketo.api.RestClient

org.mule.modules.marketo.api.CustomObjectsClientImpl

All Implemented Interfaces:

CustomObjectsClient

public class CustomObjectsClientImpl
extends RestClient
implements CustomObjectsClient

Field Summary

Fields

Modifier and Type	Field and Description
protected static javax.ws.rs.core.GenericType<MarketoResponse<CustomObject>>	CREATE_OR_UPDATE_CUSTOM_OBJECT_GENERIC_TYPE

Fields inherited from class org.mule.modules.marketo.api.RestClient

DATE_FORMAT_TIMEZONE, DATE_FORMAT_Z, DATE_FORMAT_Z_MILLIS, DATE_FORMAT_Z_TIMEZONE, DATE_ONLY_FORMAT, JOINER, RESPONSE_MAP_GENERIC_TYPE, SERVICE_RESPONSE_GENERIC_TYPE, SINGLE_ENTRY_MAP_TO_STRING, VOID_GENERIC_TYPE

Constructor Summary

Constructors

Constructor and Description
CustomObjectsClientImpl(RestClientConfigProvider configProvider)

Method Summary

Methods

Modifier and Type	Method and Description
MarketoResponse<CustomObject>	createOrUpdate(String customObjectName, List<Map<String,Object>> input, CustomObjectsActions actions, DedupeBy dedupeBy) Allows the caller to create, update, or upsert data for specified custom objects.
MarketoResponse<CustomObject>	deleteCustomObject(String customObjectName, List<Map<String,Object>> input, String deleteBy) Allows the caller to delete custom objects by dedupe fields or id field
MarketoResponse<Map<String,Object>>	describe(String name) Allows the caller to retrieve the datasense for a specified custom object.
MarketoResponse<Map<String,Object>>	getCustomObjects(String customObjectName, String filterType, List<Map<String,Object>> input, List<String> fields, String nextPageToken, Integer batchSize) Allows the caller to retrieve custom objects using specified input parameters
MarketoResponse<Map<String,Object>>	getListOfCustomObjects(List<String> customObjectNames) Allows the called to retrieve a list of custom object definitions based on a specified search criteria

Methods inherited from class org.mule.modules.marketo.api.RestClient

buildGetInvocation, buildPostInvocation, buildPostInvocation, buildPostInvocation, buildPostInvocation, bulkWebTarget, process, putIfNotNull, queryParamIfNotNull, webTarget

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_OR_UPDATE_CUSTOM_OBJECT_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<CustomObject>> CREATE_OR_UPDATE_CUSTOM_OBJECT_GENERIC_TYPE

Constructor Detail

CustomObjectsClientImpl

public CustomObjectsClientImpl(RestClientConfigProvider configProvider)

Method Detail

getListOfCustomObjects

public MarketoResponse<Map<String,Object>> getListOfCustomObjects(@Nullable
                                                         List<String> customObjectNames)

Allows the called to retrieve a list of custom object definitions based on a specified search criteria

Specified by:

getListOfCustomObjects in interface CustomObjectsClient

Parameters:

customObjectNames - list of custom object names. If not specified, then all custom objects are returned

Returns:

a {java.util.List} with the call response

describe

public MarketoResponse<Map<String,Object>> describe(@NotNull
                                           String name)

Allows the caller to retrieve the datasense for a specified custom object.

Specified by:

describe in interface CustomObjectsClient

Parameters:

name - the name of the custom object

Returns:

a {java.util.List} with the call response

createOrUpdate

public MarketoResponse<CustomObject> createOrUpdate(@NotNull
                                           String customObjectName,
                                           @NotNull
                                           List<Map<String,Object>> input,
                                           CustomObjectsActions actions,
                                           DedupeBy dedupeBy)

Allows the caller to create, update, or upsert data for specified custom objects.

Specified by:

createOrUpdate in interface CustomObjectsClient

Parameters:

customObjectName - the name of the custom object

input - the custom object definitions

actions - the storage operation. Default: createOrUpdate

dedupeBy - the deduplication method. Only valid if actions is UpdateOnly. Default: dedupeFields

Returns:

The List of CustomObject

deleteCustomObject

public MarketoResponse<CustomObject> deleteCustomObject(@NotNull
                                               String customObjectName,
                                               @NotNull
                                               List<Map<String,Object>> input,
                                               @Nullable
                                               String deleteBy)

Allows the caller to delete custom objects by dedupe fields or id field

Specified by:

deleteCustomObject in interface CustomObjectsClient

Parameters:

customObjectName - the name of the custom object

input - deletion criteria

deleteBy - the deletion method. Default: dedupeFields

Returns:

The List of CustomObject

getCustomObjects

public MarketoResponse<Map<String,Object>> getCustomObjects(@NotNull
                                                   String customObjectName,
                                                   @Nullable
                                                   String filterType,
                                                   @NotNull
                                                   List<Map<String,Object>> input,
                                                   @NotNull
                                                   List<String> fields,
                                                   String nextPageToken,
                                                   Integer batchSize)

Allows the caller to retrieve custom objects using specified input parameters

Specified by:

getCustomObjects in interface CustomObjectsClient

Parameters:

customObjectName - the name of the custom object

filterType - values: dedupeFields, idField or any of the searcheableFields set that has a single field in it

input - search values

fields - list of fields to return.

batchSize - the number of custom object records to be returned in a single call

Returns:

a {java.util.List} with the call response