java.lang.Object
- org.odpi.openmetadata.accessservices.governanceprogram.server.spring.GovernanceReviewResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/governance-program/users/{userId}")
public class GovernanceReviewResource
extends Object

GovernanceReviewResource reviews the status of the governance program.

Constructor Summary

Constructors
Constructor Description

GovernanceReviewResource()
Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GovernanceDefinitionListResponse`	`findGovernanceDefinitions(String serverName, String userId, String typeName, int startFrom, int pageSize, SearchStringRequestBody requestBody)`	Return the list of governance definitions that match the search string - this can be a regular expression.
`GovernanceDefinitionResponse`	`getGovernanceDefinitionByGUID(String serverName, String userId, String definitionGUID)`	Retrieve the certification type by the unique identifier assigned by this service when it was created.
`GovernanceDefinitionGraphResponse`	`getGovernanceDefinitionInContext(String serverName, String userId, String governanceDefinitionGUID)`	Return the governance definition associated with a unique identifier and the other governance definitions linked to it.
`GovernanceMetricImplementationListResponse`	`getGovernanceDefinitionMetrics(String serverName, String userId, String governanceDefinitionGUID, int startFrom, int pageSize)`	Return details of the metrics for a governance definition along with details of where the measurements are stored
`GovernanceDefinitionListResponse`	`getGovernanceDefinitionsForDocId(String serverName, String userId, String typeName, String docId, int startFrom, int pageSize)`	Return the list of governance definitions associated with a unique docId.
`GovernanceDefinitionListResponse`	`getGovernanceDefinitionsForDomain(String serverName, String userId, String typeName, int domainIdentifier, int startFrom, int pageSize)`	Return the list of governance definitions associated with a particular governance domain.
`ElementStubListResponse`	`getGovernanceZoneMembers(String serverName, String userId, String zoneName, String subTypeName, int startFrom, int pageSize)`	Return the list of assets that are members of a particular zone.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- GovernanceReviewResource
```
public GovernanceReviewResource()
```
  Default constructor

Method Detail

getGovernanceDefinitionByGUID

@GetMapping(path="/review/governance-definitions/{definitionGUID}")
public GovernanceDefinitionResponse getGovernanceDefinitionByGUID(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String definitionGUID)

Retrieve the certification type by the unique identifier assigned by this service when it was created.

Parameters:: serverName - name of the server instance to connect to; userId - calling user; definitionGUID - identifier of the governance definition to retrieve
Returns:: properties of the certification type or InvalidParameterException guid or userId is null; guid is not recognized PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getGovernanceDefinitionsForDomain

@GetMapping(path="/review/governance-definitions/{typeName}/for-domain")
public GovernanceDefinitionListResponse getGovernanceDefinitionsForDomain(@PathVariable
                                                                          String serverName,
                                                                          @PathVariable
                                                                          String userId,
                                                                          @PathVariable
                                                                          String typeName,
                                                                          @RequestParam
                                                                          int domainIdentifier,
                                                                          @RequestParam
                                                                          int startFrom,
                                                                          @RequestParam
                                                                          int pageSize)

Return the list of governance definitions associated with a particular governance domain.

Parameters:: serverName - name of the server instance to connect to; userId - calling user; typeName - option type name to restrict retrieval to a specific type; domainIdentifier - identifier of the governance domain - 0 = all domains; startFrom - where to start from in the list of definitions; pageSize - max number of results to return in one call
Returns:: list of governance definitions or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems

getGovernanceDefinitionsForDocId

@GetMapping(path="/review/governance-definitions/{typeName}/for-document-id/{docId}")
public GovernanceDefinitionListResponse getGovernanceDefinitionsForDocId(@PathVariable
                                                                         String serverName,
                                                                         @PathVariable
                                                                         String userId,
                                                                         @PathVariable
                                                                         String typeName,
                                                                         @PathVariable
                                                                         String docId,
                                                                         @RequestParam
                                                                         int startFrom,
                                                                         @RequestParam
                                                                         int pageSize)

Return the list of governance definitions associated with a unique docId. In an ideal world, there should be only one.

Parameters:: serverName - name of the server instance to connect to; userId - calling user; typeName - option types name to restrict retrieval to a specific type; docId - unique name of the governance definition; startFrom - where to start from in the list of definitions; pageSize - max number of results to return in one call
Returns:: list of governance definitions or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems

getGovernanceDefinitionInContext

@GetMapping(path="/review/governance-definitions/{governanceDefinitionGUID}/in-context")
public GovernanceDefinitionGraphResponse getGovernanceDefinitionInContext(@PathVariable
                                                                          String serverName,
                                                                          @PathVariable
                                                                          String userId,
                                                                          @PathVariable
                                                                          String governanceDefinitionGUID)

Return the governance definition associated with a unique identifier and the other governance definitions linked to it.

Parameters:: serverName - name of the server instance to connect to; userId - calling user; governanceDefinitionGUID - unique identifier of the governance definition
Returns:: governance definition and its linked elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems

findGovernanceDefinitions

@PostMapping(path="/review/governance-definitions/{typeName}/by-search-string")
public GovernanceDefinitionListResponse findGovernanceDefinitions(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String typeName,
                                                                  @RequestParam
                                                                  int startFrom,
                                                                  @RequestParam
                                                                  int pageSize,
                                                                  @RequestBody
                                                                  SearchStringRequestBody requestBody)

Return the list of governance definitions that match the search string - this can be a regular expression.

Parameters:: serverName - name of the server instance to connect to; userId - calling user; typeName - option types name to restrict retrieval to a specific type; requestBody - value to search for; startFrom - where to start from in the list of definition results; pageSize - max number of results to return in one call
Returns:: list of governance definitions or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems

getGovernanceDefinitionMetrics

@GetMapping(path="/review/governance-definitions/{governanceDefinitionGUID}/metrics-implementation")
public GovernanceMetricImplementationListResponse getGovernanceDefinitionMetrics(@PathVariable
                                                                                 String serverName,
                                                                                 @PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 String governanceDefinitionGUID,
                                                                                 @RequestParam
                                                                                 int startFrom,
                                                                                 @RequestParam
                                                                                 int pageSize)

Return details of the metrics for a governance definition along with details of where the measurements are stored

Parameters:: serverName - name of the server instance to connect to; userId - calling user; governanceDefinitionGUID - unique name of the governance definition; startFrom - where to start from in the list of definitions; pageSize - max number of results to return in one call
Returns:: list of associated metrics and links for retrieving the captured measurements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems

getGovernanceZoneMembers

@GetMapping(path="/review/governance-zones/{zoneName}/members/{subTypeName}")
public ElementStubListResponse getGovernanceZoneMembers(@PathVariable
                                                        String serverName,
                                                        @PathVariable
                                                        String userId,
                                                        @PathVariable
                                                        String zoneName,
                                                        @PathVariable
                                                        String subTypeName,
                                                        @RequestParam
                                                        int startFrom,
                                                        @RequestParam
                                                        int pageSize)

Return the list of assets that are members of a particular zone.

Parameters:: serverName - name of the server instance to connect to; userId - calling user; zoneName - unique name of the zone to search for; subTypeName - optional asset subtypeName to limit the results; startFrom - where to start from in the list of assets; pageSize - max number of results to return in one call
Returns:: list of headers for assets in the requested zone or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems

Class GovernanceReviewResource

Constructor Summary