Package org.odpi.openmetadata.viewservices.devopspipeline.server

Class DevopsPipelineRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.devopspipeline.server.DevopsPipelineRESTServices
public class DevopsPipelineRESTServices extends TokenController
The DevopsPipelineRESTServices provides the server-side implementation of the Devops Pipeline Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • DevopsPipelineRESTServices

      public DevopsPipelineRESTServices()
      Default constructor

  • Method Details

    • createStorageVolume

      public GUIDResponse createStorageVolume(String serverName, NewElementRequestBody requestBody)
      Create a storage volume.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • createStorageVolumeFromTemplate

      public GUIDResponse createStorageVolumeFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a storage volume using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • updateStorageVolume

      public BooleanResponse updateStorageVolume(String serverName, String storageVolumeGUID, UpdateElementRequestBody requestBody)
      Update the properties of a storage volume.
      Parameters:
      serverName - name of the server to route the request to
      storageVolumeGUID - unique identifier of the storage volume
      requestBody - properties for the request
      Returns:
      boolean - true if an update occurred or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • deleteStorageVolume

      public VoidResponse deleteStorageVolume(String serverName, String storageVolumeGUID, DeleteElementRequestBody requestBody)
      Delete a storage volume.
      Parameters:
      serverName - name of the server to route the request to
      storageVolumeGUID - unique identifier of the storage volume
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getStorageVolumesByName

      public OpenMetadataRootElementsResponse getStorageVolumesByName(String serverName, FilterRequestBody requestBody)
      Returns the list of storage volumes with a particular name.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • findStorageVolumes

      public OpenMetadataRootElementsResponse findStorageVolumes(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of storage volume metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getStorageVolumeByGUID

      public OpenMetadataRootElementResponse getStorageVolumeByGUID(String serverName, String storageVolumeGUID, GetRequestBody requestBody)
      Return the properties of a specific storage volume.
      Parameters:
      serverName - name of the server to route the request to
      storageVolumeGUID - unique identifier of the storage volume
      requestBody - properties for the request
      Returns:
      matching element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkAttachedStorage

      public VoidResponse linkAttachedStorage(String serverName, String itInfrastructureGUID, String storageVolumeGUID, NewRelationshipRequestBody requestBody)
      Attach a storage volume to the IT infrastructure that it provides storage for.
      Parameters:
      serverName - name of the server to route the request to
      itInfrastructureGUID - unique identifier of the element that the storage volume is attached to
      storageVolumeGUID - unique identifier of the storage volume
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAttachedStorage

      public VoidResponse detachAttachedStorage(String serverName, String itInfrastructureGUID, String storageVolumeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a storage volume from the IT infrastructure that it provided storage for.
      Parameters:
      serverName - name of the server to route the request to
      itInfrastructureGUID - unique identifier of the element that the storage volume is attached to
      storageVolumeGUID - unique identifier of the storage volume
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkStoredOn

      public VoidResponse linkStoredOn(String serverName, String dataStoreGUID, String storageVolumeGUID, NewRelationshipRequestBody requestBody)
      Attach a data store to the storage volume that its data is stored on.
      Parameters:
      serverName - name of the server to route the request to
      dataStoreGUID - unique identifier of the data store
      storageVolumeGUID - unique identifier of the storage volume
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachStoredOn

      public VoidResponse detachStoredOn(String serverName, String dataStoreGUID, String storageVolumeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data store from the storage volume that its data was stored on.
      Parameters:
      serverName - name of the server to route the request to
      dataStoreGUID - unique identifier of the data store
      storageVolumeGUID - unique identifier of the storage volume
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • createNetwork

      public GUIDResponse createNetwork(String serverName, NewElementRequestBody requestBody)
      Create a network.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • createNetworkFromTemplate

      public GUIDResponse createNetworkFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a network using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • updateNetwork

      public BooleanResponse updateNetwork(String serverName, String networkGUID, UpdateElementRequestBody requestBody)
      Update the properties of a network.
      Parameters:
      serverName - name of the server to route the request to
      networkGUID - unique identifier of the network
      requestBody - properties for the request
      Returns:
      boolean - true if an update occurred or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • deleteNetwork

      public VoidResponse deleteNetwork(String serverName, String networkGUID, DeleteElementRequestBody requestBody)
      Delete a network.
      Parameters:
      serverName - name of the server to route the request to
      networkGUID - unique identifier of the network
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getNetworksByName

      public OpenMetadataRootElementsResponse getNetworksByName(String serverName, FilterRequestBody requestBody)
      Returns the list of networks with a particular name.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • findNetworks

      public OpenMetadataRootElementsResponse findNetworks(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of network metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getNetworkByGUID

      public OpenMetadataRootElementResponse getNetworkByGUID(String serverName, String networkGUID, GetRequestBody requestBody)
      Return the properties of a specific network.
      Parameters:
      serverName - name of the server to route the request to
      networkGUID - unique identifier of the network
      requestBody - properties for the request
      Returns:
      matching element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • createNetworkGateway

      public GUIDResponse createNetworkGateway(String serverName, NewElementRequestBody requestBody)
      Create a network gateway.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • createNetworkGatewayFromTemplate

      public GUIDResponse createNetworkGatewayFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a network gateway using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • updateNetworkGateway

      public BooleanResponse updateNetworkGateway(String serverName, String networkGatewayGUID, UpdateElementRequestBody requestBody)
      Update the properties of a network gateway.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayGUID - unique identifier of the network gateway
      requestBody - properties for the request
      Returns:
      boolean - true if an update occurred or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • deleteNetworkGateway

      public VoidResponse deleteNetworkGateway(String serverName, String networkGatewayGUID, DeleteElementRequestBody requestBody)
      Delete a network gateway.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayGUID - unique identifier of the network gateway
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getNetworkGatewaysByName

      public OpenMetadataRootElementsResponse getNetworkGatewaysByName(String serverName, FilterRequestBody requestBody)
      Returns the list of network gateways with a particular name.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • findNetworkGateways

      public OpenMetadataRootElementsResponse findNetworkGateways(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of network gateway metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getNetworkGatewayByGUID

      public OpenMetadataRootElementResponse getNetworkGatewayByGUID(String serverName, String networkGatewayGUID, GetRequestBody requestBody)
      Return the properties of a specific network gateway.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayGUID - unique identifier of the network gateway
      requestBody - properties for the request
      Returns:
      matching element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkVisibleEndpoint

      public VoidResponse linkVisibleEndpoint(String serverName, String endpointGUID, String networkGUID, NewRelationshipRequestBody requestBody)
      Attach an endpoint to the network that it is visible in.
      Parameters:
      serverName - name of the server to route the request to
      endpointGUID - unique identifier of the endpoint
      networkGUID - unique identifier of the network
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachVisibleEndpoint

      public VoidResponse detachVisibleEndpoint(String serverName, String endpointGUID, String networkGUID, DeleteRelationshipRequestBody requestBody)
      Detach an endpoint from the network that it was visible in.
      Parameters:
      serverName - name of the server to route the request to
      endpointGUID - unique identifier of the endpoint
      networkGUID - unique identifier of the network
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkNetworkGateway

      public GUIDResponse linkNetworkGateway(String serverName, String networkGatewayGUID, String networkGUID, NewRelationshipRequestBody requestBody)
      Attach a network gateway to a network that it connects to. NetworkGatewayLink is a multi-link relationship so this always creates a new relationship and returns its unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayGUID - unique identifier of the network gateway
      networkGUID - unique identifier of the network
      requestBody - properties for the relationship
      Returns:
      unique identifier of the new relationship or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • updateNetworkGatewayLink

      public VoidResponse updateNetworkGatewayLink(String serverName, String networkGatewayLinkGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties of a network gateway link.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayLinkGUID - unique identifier of the network gateway link relationship
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachNetworkGateway

      public VoidResponse detachNetworkGateway(String serverName, String networkGatewayLinkGUID, DeleteRelationshipRequestBody requestBody)
      Detach a network gateway from a network that it connected to.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayLinkGUID - unique identifier of the network gateway link relationship
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkHostClusterMember

      public VoidResponse linkHostClusterMember(String serverName, String hostClusterGUID, String hostGUID, NewRelationshipRequestBody requestBody)
      Attach a host to the host cluster that manages it.
      Parameters:
      serverName - name of the server to route the request to
      hostClusterGUID - unique identifier of the host cluster
      hostGUID - unique identifier of the host that is managed by the cluster
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachHostClusterMember

      public VoidResponse detachHostClusterMember(String serverName, String hostClusterGUID, String hostGUID, DeleteRelationshipRequestBody requestBody)
      Detach a host from the host cluster that managed it.
      Parameters:
      serverName - name of the server to route the request to
      hostClusterGUID - unique identifier of the host cluster
      hostGUID - unique identifier of the host that was managed by the cluster
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • createOperatingPlatform

      public GUIDResponse createOperatingPlatform(String serverName, NewElementRequestBody requestBody)
      Create a operating platform.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • createOperatingPlatformFromTemplate

      public GUIDResponse createOperatingPlatformFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a operating platform using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • updateOperatingPlatform

      public BooleanResponse updateOperatingPlatform(String serverName, String operatingPlatformGUID, UpdateElementRequestBody requestBody)
      Update the properties of a operating platform.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier of the operating platform
      requestBody - properties for the request
      Returns:
      boolean - true if an update occurred or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • deleteOperatingPlatform

      public VoidResponse deleteOperatingPlatform(String serverName, String operatingPlatformGUID, DeleteElementRequestBody requestBody)
      Delete a operating platform.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier of the operating platform
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getOperatingPlatformsByName

      public OpenMetadataRootElementsResponse getOperatingPlatformsByName(String serverName, FilterRequestBody requestBody)
      Returns the list of operating platforms with a particular name.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • findOperatingPlatforms

      public OpenMetadataRootElementsResponse findOperatingPlatforms(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of operating platform metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getOperatingPlatformByGUID

      public OpenMetadataRootElementResponse getOperatingPlatformByGUID(String serverName, String operatingPlatformGUID, GetRequestBody requestBody)
      Return the properties of a specific operating platform.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier of the operating platform
      requestBody - properties for the request
      Returns:
      matching element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkOperatingPlatformUse

      public VoidResponse linkOperatingPlatformUse(String serverName, String operatingPlatformGUID, String itInfrastructureGUID, NewRelationshipRequestBody requestBody)
      Attach an operating platform to the IT infrastructure that it is installed on.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier of the operating platform
      itInfrastructureGUID - unique identifier of the IT infrastructure that the operating platform is installed on
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachOperatingPlatformUse

      public VoidResponse detachOperatingPlatformUse(String serverName, String operatingPlatformGUID, String itInfrastructureGUID, DeleteRelationshipRequestBody requestBody)
      Detach an operating platform from the IT infrastructure that it was installed on.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier of the operating platform
      itInfrastructureGUID - unique identifier of the IT infrastructure that the operating platform is installed on
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkOperatingPlatformManifest

      public VoidResponse linkOperatingPlatformManifest(String serverName, String operatingPlatformGUID, String collectionGUID, NewRelationshipRequestBody requestBody)
      Attach an operating platform to the collection of software packages that it is packaged with.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier of the operating platform
      collectionGUID - unique identifier of the collection of software packages
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachOperatingPlatformManifest

      public VoidResponse detachOperatingPlatformManifest(String serverName, String operatingPlatformGUID, String collectionGUID, DeleteRelationshipRequestBody requestBody)
      Detach an operating platform from a collection of software packages that it was packaged with.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier of the operating platform
      collectionGUID - unique identifier of the collection of software packages
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkSoftwarePackageDependency

      public VoidResponse linkSoftwarePackageDependency(String serverName, String assetGUID, String collectionGUID, NewRelationshipRequestBody requestBody)
      Attach an asset to the collection of software packages that it depends on when it is running.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the asset
      collectionGUID - unique identifier of the collection of software packages
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachSoftwarePackageDependency

      public VoidResponse detachSoftwarePackageDependency(String serverName, String assetGUID, String collectionGUID, DeleteRelationshipRequestBody requestBody)
      Detach an asset from a collection of software packages that it no longer depends on.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the asset
      collectionGUID - unique identifier of the collection of software packages
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setSoftwarePackageManifest

      public VoidResponse setSoftwarePackageManifest(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify an element to indicate that it describes a list of software packages.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearSoftwarePackageManifest

      public VoidResponse clearSoftwarePackageManifest(String serverName, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the software package manifest designation from the element.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAsCloudPlatform

      public VoidResponse setAsCloudPlatform(String serverName, String softwareServerPlatformGUID, NewClassificationRequestBody requestBody)
      Classify a software server platform to say that it is a cloud platform.
      Parameters:
      serverName - name of the server to route the request to
      softwareServerPlatformGUID - unique identifier of the software server platform
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAsCloudPlatform

      public VoidResponse clearAsCloudPlatform(String serverName, String softwareServerPlatformGUID, DeleteClassificationRequestBody requestBody)
      Remove the cloud platform designation from a software server platform.
      Parameters:
      serverName - name of the server to route the request to
      softwareServerPlatformGUID - unique identifier of the software server platform
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setHostAsCloudProvider

      public VoidResponse setHostAsCloudProvider(String serverName, String hostGUID, NewClassificationRequestBody requestBody)
      Classify a host to say that it is a cloud provider.
      Parameters:
      serverName - name of the server to route the request to
      hostGUID - unique identifier of the host
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearHostAsCloudProvider

      public VoidResponse clearHostAsCloudProvider(String serverName, String hostGUID, DeleteClassificationRequestBody requestBody)
      Remove the cloud provider designation from a host.
      Parameters:
      serverName - name of the server to route the request to
      hostGUID - unique identifier of the host
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setServerAsCloudTenant

      public VoidResponse setServerAsCloudTenant(String serverName, String softwareServerGUID, NewClassificationRequestBody requestBody)
      Classify a software server to say that it is hosting a cloud tenant.
      Parameters:
      serverName - name of the server to route the request to
      softwareServerGUID - unique identifier of the software server
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearServerAsCloudTenant

      public VoidResponse clearServerAsCloudTenant(String serverName, String softwareServerGUID, DeleteClassificationRequestBody requestBody)
      Remove the cloud tenant designation from a software server.
      Parameters:
      serverName - name of the server to route the request to
      softwareServerGUID - unique identifier of the software server
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setCapabilityAsCloudService

      public VoidResponse setCapabilityAsCloudService(String serverName, String softwareCapabilityGUID, NewClassificationRequestBody requestBody)
      Classify a software capability to say that it is a cloud service.
      Parameters:
      serverName - name of the server to route the request to
      softwareCapabilityGUID - unique identifier of the software capability
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearCapabilityAsCloudService

      public VoidResponse clearCapabilityAsCloudService(String serverName, String softwareCapabilityGUID, DeleteClassificationRequestBody requestBody)
      Remove the cloud service designation from a software capability.
      Parameters:
      serverName - name of the server to route the request to
      softwareCapabilityGUID - unique identifier of the software capability
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkReusableTechniqueUse

      public VoidResponse linkReusableTechniqueUse(String serverName, String techniqueUserGUID, String reusableTechniqueGUID, NewRelationshipRequestBody requestBody)
      Attach an element to the reusable technique that it makes use of.
      Parameters:
      serverName - name of the server to route the request to
      techniqueUserGUID - unique identifier of the element that uses the technique
      reusableTechniqueGUID - unique identifier of the element classified as a reusable technique
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachReusableTechniqueUse

      public VoidResponse detachReusableTechniqueUse(String serverName, String techniqueUserGUID, String reusableTechniqueGUID, DeleteRelationshipRequestBody requestBody)
      Detach an element from a reusable technique that it no longer makes use of.
      Parameters:
      serverName - name of the server to route the request to
      techniqueUserGUID - unique identifier of the element that uses the technique
      reusableTechniqueGUID - unique identifier of the element classified as a reusable technique
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkDependentSoftwareComponent

      public VoidResponse linkDependentSoftwareComponent(String serverName, String dependentComponentGUID, String dependedOnComponentGUID, NewRelationshipRequestBody requestBody)
      Attach a runnable software component to a component that it needs in order to execute.
      Parameters:
      serverName - name of the server to route the request to
      dependentComponentGUID - unique identifier of the component that has the dependency
      dependedOnComponentGUID - unique identifier of the component that is depended on
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachDependentSoftwareComponent

      public VoidResponse detachDependentSoftwareComponent(String serverName, String dependentComponentGUID, String dependedOnComponentGUID, DeleteRelationshipRequestBody requestBody)
      Detach a runnable software component from a component that it no longer needs in order to execute.
      Parameters:
      serverName - name of the server to route the request to
      dependentComponentGUID - unique identifier of the component that has the dependency
      dependedOnComponentGUID - unique identifier of the component that is depended on
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkSoftwareSource

      public VoidResponse linkSoftwareSource(String serverName, String assetGUID, String softwareComponentGUID, NewRelationshipRequestBody requestBody)
      Attach a software asset to the software component that it is built from.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the software asset
      softwareComponentGUID - unique identifier of the software component
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachSoftwareSource

      public VoidResponse detachSoftwareSource(String serverName, String assetGUID, String softwareComponentGUID, DeleteRelationshipRequestBody requestBody)
      Detach a software asset from the software component that it was built from.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the software asset
      softwareComponentGUID - unique identifier of the software component
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setElementAsGeneratedTarget

      public VoidResponse setElementAsGeneratedTarget(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify an element to say that it is the generated output of a build program or script.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element to classify
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearElementAsGeneratedTarget

      public VoidResponse clearElementAsGeneratedTarget(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the generated target designation from an element.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element to declassify
      requestBody - metadata source options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setElementAsReusableTechnique

      public VoidResponse setElementAsReusableTechnique(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify an element to say that it is a technique that can be reused in multiple contexts.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element to classify
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearElementAsReusableTechnique

      public VoidResponse clearElementAsReusableTechnique(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the reusable technique designation from an element.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element to declassify
      requestBody - metadata source options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)