Package org.odpi.openmetadata.accessservices.discoveryengine.rest
This package defines the beans used to build the REST request and response payloads.
REST APIs can pass parameters in their URLs (called path variables) as well has having a RequestBody bean
for additional, more complex, or optional parameters. Responses are returned in response beans.
The response beans encode the return type of the method as well as any exceptions and associated messages.
-
Class Summary Class Description AnnotationListResponse AnnotationListResponse is the response structure used on OMAS REST API calls that return a list of Annotations objects as a response.AnnotationRequestBody CommentRequestBody provides a structure for passing a comment as a request body over a REST API.AnnotationResponse AnnotationResponse is the response structure used on the OMAS REST API calls that return a Annotation object as a response.DataFieldListResponse DataFieldListResponse is the response structure used on OMAS REST API calls that return a list of DataField objects as a response.DataFieldResponse DataFieldResponse is the response structure used on the OMAS REST API calls that return a DataField object as a response.DeleteRequestBody DeleteRequestBody provides a structure for passing the qualified name of an object to be deleted.DiscoveryAnalysisReportListResponse DiscoveryAnalysisReportListResponse is the response structure used on OMAS REST API calls that return a list of DiscoveryAnalysisReport properties objects as a response.DiscoveryAnalysisReportRequestBody DiscoveryAnalysisReportRequestBody provides a structure for passing the properties of a discovery analysis report as a request body over a REST API.DiscoveryAnalysisReportResponse DiscoveryAnalysisReportResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a Connection object as a response.DiscoveryEngineListResponse DiscoveryEngineListsResponse is the response structure used on the Discovery Engine OMAS REST API calls that returns a list of DiscoveryEngineProperties objects as a response.DiscoveryEnginePropertiesResponse DiscoveryEnginePropertiesResponse is the response structure used on the Discovery Engine OMAS REST API calls that returns a DiscoveryEngineProperties object as a response.DiscoveryRequestRequestBody CommentRequestBody provides a structure for passing a comment as a request body over a REST API.DiscoveryRequestStatusResponse DiscoveryRequestStatusResponse is the response structure used on the OMAS REST API calls that return a DiscoveryRequestStatus enum.DiscoveryServiceListResponse DiscoveryServiceListsResponse is the response structure used on the Discovery Engine OMAS REST API calls that returns a list of DiscoveryServiceProperties objects as a response.DiscoveryServicePropertiesResponse DiscoveryServicePropertiesResponse is the response structure used on the Discovery Engine OMAS REST API calls that returns a DiscoveryServiceProperties object as a response.DiscoveryServiceRegistrationRequestBody DiscoveryServiceRegistrationRequestBody provides a structure for passing details of a discovery service that is to be registered with a discovery engine.NewDiscoveryEngineRequestBody NewDiscoveryEngineRequestBody provides a structure for passing the properties of a new discovery engine as a request body over a REST API.NewDiscoveryServiceRequestBody NewDiscoveryServiceRequestBody provides a structure for passing the properties of a new discovery service as a request body over a REST API.ODFOMASAPIRequestBody ODFOMASAPIRequestBody provides a common header for Open Discovery Framework (ODF) bean-based request bodies.ODFOMASAPIResponse ODFOMASAPIResponse provides a common header for or Open Discovery Framework (ODF) bean-based REST responses.ReferenceableRequestBody ReferenceableRequestBody provides a structure for passing a referenceables' properties as a request body over a REST API.RegisteredDiscoveryServiceResponse DiscoveryServicePropertiesResponse is the response structure used on the Discovery Engine OMAS REST API calls that returns a DiscoveryServiceProperties object as a response.StatusRequestBody StatusRequestBody provides a structure for passing the annotation status of an Annotation.UpdateDiscoveryEngineRequestBody UpdateDiscoveryEngineRequestBody provides a structure for passing the updated properties of a discovery engine as a request body over a REST API.UpdateDiscoveryServiceRequestBody UpdateDiscoveryServiceRequestBody provides a structure for passing the updated properties of a discovery service as a request body over a REST API.