Interface DeploymentManagementInterface

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearDeployment​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String itAssetGUID, java.lang.String destinationGUID, java.util.Date effectiveTime)
      Remove a deployment relationship.
      void deployITAsset​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String itAssetGUID, java.lang.String destinationGUID, DeploymentProperties deploymentProperties)
      Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).
      java.util.List<DeploymentElement> getDeployedITAssets​(java.lang.String userId, java.lang.String destinationGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of assets deployed on a particular destination.
      java.util.List<DeploymentElement> getDeploymentDestinations​(java.lang.String userId, java.lang.String itAssetGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of destinations that a particular IT infrastructure asset is deployed to.
      void updateITAssetDeployment​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String deploymentGUID, boolean isMergeUpdate, DeploymentProperties deploymentProperties)
      Update a deployment relationship.
    • Method Detail

      • deployITAsset

        void deployITAsset​(java.lang.String userId,
                           java.lang.String infrastructureManagerGUID,
                           java.lang.String infrastructureManagerName,
                           boolean infrastructureManagerIsHome,
                           java.lang.String itAssetGUID,
                           java.lang.String destinationGUID,
                           DeploymentProperties deploymentProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
        infrastructureManagerName - unique name of software server capability representing the infrastructure manager
        infrastructureManagerIsHome - should the relationship be marked as owned by the infrastructure manager so others can not update?
        itAssetGUID - unique identifier of the IT infrastructure asset
        destinationGUID - unique identifier of the destination where the asset is being deployed to
        deploymentProperties - relationship properties
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateITAssetDeployment

        void updateITAssetDeployment​(java.lang.String userId,
                                     java.lang.String infrastructureManagerGUID,
                                     java.lang.String infrastructureManagerName,
                                     java.lang.String deploymentGUID,
                                     boolean isMergeUpdate,
                                     DeploymentProperties deploymentProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update a deployment relationship.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
        infrastructureManagerName - unique name of software server capability representing the infrastructure manager
        deploymentGUID - unique identifier of the relationship
        isMergeUpdate - should the supplied properties be merged with existing properties (true) by replacing just the properties with matching names, or should the entire properties of the instance be replaced?
        deploymentProperties - properties for the relationship
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearDeployment

        void clearDeployment​(java.lang.String userId,
                             java.lang.String infrastructureManagerGUID,
                             java.lang.String infrastructureManagerName,
                             java.lang.String itAssetGUID,
                             java.lang.String destinationGUID,
                             java.util.Date effectiveTime)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Remove a deployment relationship.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
        infrastructureManagerName - unique name of software server capability representing the infrastructure manager
        itAssetGUID - unique identifier of the IT infrastructure asset
        destinationGUID - unique identifier of the destination where the asset is being deployed to
        effectiveTime - time when the deployment is effective
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getDeployedITAssets

        java.util.List<DeploymentElement> getDeployedITAssets​(java.lang.String userId,
                                                              java.lang.String destinationGUID,
                                                              java.util.Date effectiveTime,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
        Return the list of assets deployed on a particular destination.
        Parameters:
        userId - calling user
        destinationGUID - unique identifier of the destination asset to query
        effectiveTime - effective time for the query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getDeploymentDestinations

        java.util.List<DeploymentElement> getDeploymentDestinations​(java.lang.String userId,
                                                                    java.lang.String itAssetGUID,
                                                                    java.util.Date effectiveTime,
                                                                    int startFrom,
                                                                    int pageSize)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException
        Return the list of destinations that a particular IT infrastructure asset is deployed to.
        Parameters:
        userId - calling user
        itAssetGUID - unique identifier of the IT infrastructure asset to query
        effectiveTime - effective time for the query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)