Package com.adobe.aio.event.management
Interface ProviderService
-
public interface ProviderService
This interface methods are returning either Optional or List. When the underlying Adobe IO http API endpoints are responding with `404`, these methods will return empty Optional or empty List. When the underlying Adobe IO http API endpoints are responding with other `4xx` or `5xx` errors, these methods will throw runtime FeignException exposing these error codes. We may work on a more specific error handling as part of https://github.com/adobe/aio-lib-java/issues/7.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ProviderService.Builder
-
Method Summary
-
-
-
Method Detail
-
deleteProvider
void deleteProvider(String providerId)
-
createProvider
Optional<Provider> createProvider(ProviderInputModel providerCreateModel)
-
createOrUpdateProvider
Optional<Provider> createOrUpdateProvider(ProviderInputModel providerInputModel)
- Parameters:
providerInputModel
- the input payload- Returns:
- create and if conflict/409 arises, instead, update a provider using the provided payload
-
updateProvider
Optional<Provider> updateProvider(String id, ProviderInputModel providerUpdateModel)
-
findCustomEventsProviderByInstanceId
Optional<Provider> findCustomEventsProviderByInstanceId(String instanceId)
- Parameters:
instanceId
- the AIO Events Provider instance identifier (either chosen by the user or generated by AIO Events backend), note the triple (provider_metadata_id, instanceId, imsOrgId) is unique- Returns:
- the `Custom Events` Provider associated with the provided instanceId
-
findProviderBy
Optional<Provider> findProviderBy(String providerMetadataId, String instanceId)
- Parameters:
providerMetadataId
- indicating the type of provider, if you are interested in `Custom Events`provider use findCustomEventsProviderByInstanceIdinstanceId
- the AIO Events Provider instance identifier (either chosen by the user or generated by AIO Events backend), * note the triple (provider_metadata_id, instanceId, imsOrgId) is unique- Returns:
- the providers list matching the provided criteria and with non-empty event metadata list
- See Also:
findCustomEventsProviderByInstanceId(String)
-
getEventMetadata
List<EventMetadata> getEventMetadata(String providerId)
-
getEventMetadata
Optional<EventMetadata> getEventMetadata(String providerId, String eventCode)
-
createEventMetadata
Optional<EventMetadata> createEventMetadata(String providerId, EventMetadata eventMetadata)
-
updateEventMetadata
Optional<EventMetadata> updateEventMetadata(String providerId, EventMetadata eventMetadata)
-
deleteAllEventMetadata
void deleteAllEventMetadata(String providerId)
-
builder
static ProviderService.Builder builder()
-
getSampleEvent
Optional<SampleEvent> getSampleEvent(String providerId, String eventCode)
-
-