Package org.odpi.openmetadata.accessservices.analyticsmodeling.api

Interface AnalyticsModelingSynchronization

public interface AnalyticsModelingSynchronization

Method Summary

Modifier and Type	Method	Description
ResponseContainerAssets	createArtifact(String userId, String serverCapability, String serverCapabilityGUID, AnalyticsAsset artifact)	Create analytics artifact defined as input.
ResponseContainerAssets	deleteArtifact(String userId, String serverCapability, String serverCapabilityGUID, String identifier)	Delete assets in repository defined by artifact unique identifier.
ResponseContainerAssets	updateArtifact(String userId, String serverCapability, String serverCapabilityGUID, AnalyticsAsset artifact)	Update analytics artifact defined as input.

Method Detail

createArtifact

ResponseContainerAssets createArtifact(String userId,
                                       String serverCapability,
                                       String serverCapabilityGUID,
                                       AnalyticsAsset artifact)
                                throws PropertyServerException,
                                       AnalyticsModelingCheckedException,
                                       InvalidParameterException,
                                       UserNotAuthorizedException

Create analytics artifact defined as input.

Parameters:

userId - requested the operation.

serverCapability - source where artifact persist.

serverCapabilityGUID - source where artifact persist.

artifact - definition.

Returns:

response with artifact or error description.

Throws:

PropertyServerException - in case REST call failed.

AnalyticsModelingCheckedException - error executing request.

UserNotAuthorizedException - in case user unauthorized to perform operation.

InvalidParameterException - in case any passed parameter is invalid.

updateArtifact

ResponseContainerAssets updateArtifact(String userId,
                                       String serverCapability,
                                       String serverCapabilityGUID,
                                       AnalyticsAsset artifact)
                                throws PropertyServerException,
                                       AnalyticsModelingCheckedException,
                                       InvalidParameterException,
                                       UserNotAuthorizedException

Update analytics artifact defined as input.

Parameters:

userId - requested the operation.

serverCapability - source where artifact persist.

serverCapabilityGUID - source where artifact persist.

artifact - definition.

Returns:

response with artifact or error description.

Throws:

PropertyServerException - in case REST call failed.

AnalyticsModelingCheckedException - error executing request.

UserNotAuthorizedException - in case user unauthorized to perform operation.

InvalidParameterException - in case any passed parameter is invalid.

deleteArtifact

ResponseContainerAssets deleteArtifact(String userId,
                                       String serverCapability,
                                       String serverCapabilityGUID,
                                       String identifier)
                                throws PropertyServerException,
                                       AnalyticsModelingCheckedException,
                                       InvalidParameterException,
                                       UserNotAuthorizedException

Delete assets in repository defined by artifact unique identifier.

Parameters:

userId - request user

serverCapability - where the artifact is stored.

serverCapabilityGUID - source where artifact persist.

identifier - of the artifact in 3rd party system.

Returns:

errors or list of created assets.

Throws:

PropertyServerException - in case REST call failed.

AnalyticsModelingCheckedException - error executing request.

UserNotAuthorizedException - in case user unauthorized to perform operation.

InvalidParameterException - in case any passed parameter is invalid.