Index (Data Platform OMAS API 0.2 API)

A D E G H I O P S T U V

A

AdditionalProperties - Class in org.odpi.openmetadata.accessservices.dataplatform.properties
AdditionalProperties() - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.properties.AdditionalProperties

D

DatabaseServer - Class in org.odpi.openmetadata.accessservices.dataplatform.properties
DatabaseServer() - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.properties.DatabaseServer
DataPlatform - Class in org.odpi.openmetadata.accessservices.dataplatform.properties: DataPlatform defines an endpoint and connectors for the runtime environment for a collection of data assets.
DataPlatform() - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.properties.DataPlatform: Default constructor.
DataPlatform(DataPlatform) - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.properties.DataPlatform: Copy/clone constructor - the parentAsset is passed separately to the template because it is also likely to be being cloned in the same operation and we want the infrastructure clone to point to the asset clone and not the original asset.
DataPlatformAsset - Class in org.odpi.openmetadata.accessservices.dataplatform.properties: DataPlatformAsset provides a superclass for the different types of Asset stored on a DataPlatform.
DataPlatformAsset() - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.properties.DataPlatformAsset
DataPlatformCheckedExceptionBase - Exception in org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions: DataPlatformCheckedExceptionBase provides a checked exception for reporting errors found when using the Data Platform OMAS services.
DataPlatformCheckedExceptionBase(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: This is the typical constructor used for creating an exception.
DataPlatformCheckedExceptionBase(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: This is the constructor used for creating an exception that resulted from a previous error.
DataPlatformErrorCode - Enum in org.odpi.openmetadata.accessservices.dataplatform.ffdc: The DataPlatformErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Data Platform OMAS Services.
DataPlatformOMASAPIResponse - Class in org.odpi.openmetadata.accessservices.dataplatform.responses: DataPlatformOMASAPIResponse provides a common header for Data Platform OMAS managed rest to its REST API.
DataPlatformOMASAPIResponse() - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Default constructor
DataPlatformOMASAPIResponse(DataPlatformOMASAPIResponse) - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Copy/clone constructor
DataPlatformRuntimeException - Exception in org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions: DataPlatformRuntimeException is used for all runtime exceptions generated by the Data Platform OMAS.
DataPlatformRuntimeException(int, String, String, String, String, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: This is the typical constructor used for creating an exception.
DataPlatformRuntimeException(int, String, String, String, String, String, Throwable, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: This is the constructor used for creating an exception when an unexpected error has been caught.

E

equals(Object) - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: Return comparison result based on the content of the properties.
equals(Object) - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: Return comparison result based on the content of the properties.
equals(Object) - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.InvalidParameterException: Return comparison result based on the content of the properties.
equals(Object) - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UnrecognizedGUIDException: Return comparison result based on the content of the properties.
equals(Object) - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UserNotAuthorizedException: Return comparison result based on the content of the properties.
equals(Object) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Return comparison result based on the content of the properties.
equals(Object) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.GUIDResponse: Return comparison result based on the content of the properties.

G

getDataPlatformEndpoint() - Method in class org.odpi.openmetadata.accessservices.dataplatform.properties.DataPlatform: Return the endpoint defined for this data platform.
getErrorMessage() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: A formatted short description of the cause of the condition that resulted in this exception.
getErrorMessage() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: A formatted short description of the cause of the condition that resulted in this exception.
getErrorMessageId() - Method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode: Returns the unique identifier for the error message.
getExceptionClassName() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Return the name of the Java class name to use to recreate the exception.
getExceptionErrorMessage() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Return the error message associated with the exception.
getExceptionProperties() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Return the additional properties stored by the exceptions.
getExceptionSystemAction() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Return the description of the action taken by the system as a result of the exception.
getExceptionUserAction() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Return the action that a user should take to resolve the problem.
getExpectedTypeName() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UnrecognizedGUIDException: Return the type name of the element expected to be retrieved.
getFormattedErrorMessage(String...) - Method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode: Returns the error message with the placeholders filled out with the supplied parameters.
getGUID() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UnrecognizedGUIDException: Return the guid supplied on the request that failed.
getGUID() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.GUIDResponse: Return the guid result.
getHTTPErrorCode() - Method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode
getParameterName() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.InvalidParameterException: Return the invalid parameter's name, if known.
getRelatedHTTPCode() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Return the HTTP Code to use if forwarding response to HTTP client.
getRelatedProperties() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: Return any additional properties that were added to the exception to aid diagnosis.
getReportedCaughtException() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: An exception that was caught and wrapped by this exception.
getReportedCaughtException() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: An exception that was caught and wrapped by this exception.
getReportedHTTPCode() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: Return the HTTP response code to use with this exception.
getReportedHTTPCode() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: Return the HTTP response code to use with this exception.
getReportedSystemAction() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: A description of the action that the system took as a result of the error condition.
getReportedSystemAction() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: A description of the action that the system took as a result of the error condition.
getReportedUserAction() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: A description of the action necessary to correct the error.
getReportedUserAction() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: A description of the action necessary to correct the error.
getReportingActionDescription() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: The type of request that the class was performing when the condition occurred that resulted in this exception.
getReportingActionDescription() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: The type of request that the class was performing when the condition occurred that resulted in this exception.
getReportingClassName() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: The class that created this exception.
getReportingClassName() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: The class that created this exception.
getSystemAction() - Method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode: Returns a description of the action taken by the system when the condition that caused this exception was detected.
getUnformattedErrorMessage() - Method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode: Returns the error message with placeholders for specific details.
getUserAction() - Method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode: Returns instructions of how to resolve the issue reported in this exception.
getUserId() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UserNotAuthorizedException: Return the userId passed on the request.
GUIDResponse - Class in org.odpi.openmetadata.accessservices.dataplatform.responses: GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.
GUIDResponse() - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.responses.GUIDResponse: Default constructor
GUIDResponse(GUIDResponse) - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.responses.GUIDResponse: Copy/clone constructor

H

hashCode() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformCheckedExceptionBase: Return hash code for this object
hashCode() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: Return hash code for this object
hashCode() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.InvalidParameterException: Return hash code for this object
hashCode() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UnrecognizedGUIDException: Return hash code for this object
hashCode() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UserNotAuthorizedException: Return hash code for this object
hashCode() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Return hash code for this object
hashCode() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.GUIDResponse: Return hash code for this object

I

InvalidParameterException - Exception in org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions: The InvalidParameterException is thrown by the OMAS when a parameters is null or an invalid value.
InvalidParameterException(int, String, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.InvalidParameterException: This is the typical constructor used for creating an exception.
InvalidParameterException(int, String, String, String, String, String, Throwable, String) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.InvalidParameterException: This is the constructor used for creating an exception that resulted from a previous error.

O

org.odpi.openmetadata.accessservices.dataplatform.ffdc - package org.odpi.openmetadata.accessservices.dataplatform.ffdc
org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions - package org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions
org.odpi.openmetadata.accessservices.dataplatform.properties - package org.odpi.openmetadata.accessservices.dataplatform.properties
org.odpi.openmetadata.accessservices.dataplatform.responses - package org.odpi.openmetadata.accessservices.dataplatform.responses

P

PropertyServerException - Exception in org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions: The PropertyServerException is thrown by the OMAS when it is not able to communicate with the property server.
PropertyServerException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.PropertyServerException: This is the typical constructor used for creating an exception.
PropertyServerException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.PropertyServerException: This is the constructor used for creating an exception that resulted from a previous error.

S

setDataPlatformEndpoint(Endpoint) - Method in class org.odpi.openmetadata.accessservices.dataplatform.properties.DataPlatform: Set up the endpoint defined for this data platform.
setExceptionClassName(String) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Set up the name of the Java class name to use to recreate the exception.
setExceptionErrorMessage(String) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Set up the error message associated with the exception.
setExceptionProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Set up the additional properties stored by the exceptions.
setExceptionSystemAction(String) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Set up the description of the action taken by the system as a result of the exception.
setExceptionUserAction(String) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Set up the action that a user should take to resolve the problem.
setGUID(String) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.GUIDResponse: Set up the guid result.
setRelatedHTTPCode(int) - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: Set up the HTTP Code to use if forwarding response to HTTP client.

T

toString() - Method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode: JSON-style toString
toString() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.DataPlatformRuntimeException: JSON-style toString
toString() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.InvalidParameterException: JSON-style toString
toString() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.PropertyServerException: JSON-style toString
toString() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UnrecognizedGUIDException: JSON-style toString
toString() - Method in exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UserNotAuthorizedException: JSON-style toString
toString() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.DataPlatformOMASAPIResponse: JSON-like toString
toString() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.GUIDResponse: JSON-style toString
toString() - Method in class org.odpi.openmetadata.accessservices.dataplatform.responses.VoidResponse: JSON-style toString

U

UnrecognizedGUIDException - Exception in org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions: The UnrecognizedGUIDException is thrown by the OMAS when the GUID passed to it is not valid.
UnrecognizedGUIDException(int, String, String, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UnrecognizedGUIDException: This is the typical constructor used for creating an exception.
UnrecognizedGUIDException(int, String, String, String, String, String, Throwable, String, String) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UnrecognizedGUIDException: This is the constructor used for creating an exception that resulted from a previous error.
UserNotAuthorizedException - Exception in org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions: The UserNotAuthorizedException is thrown by the OMAS when a userId passed on a request is not authorized to perform the requested action.
UserNotAuthorizedException(int, String, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UserNotAuthorizedException: This is the typical constructor used for creating an exception.
UserNotAuthorizedException(int, String, String, String, String, String, Throwable, String) - Constructor for exception org.odpi.openmetadata.accessservices.dataplatform.ffdc.exceptions.UserNotAuthorizedException: This is the constructor used for creating an exception that resulted from a previous error.

V

valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.
VendorProperties - Class in org.odpi.openmetadata.accessservices.dataplatform.properties
VendorProperties() - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.properties.VendorProperties
VoidResponse - Class in org.odpi.openmetadata.accessservices.dataplatform.responses: VoidResponse defines the response structure for the OMAS REST API calls that returns a void as a response.
VoidResponse() - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.responses.VoidResponse: Default constructor
VoidResponse(VoidResponse) - Constructor for class org.odpi.openmetadata.accessservices.dataplatform.responses.VoidResponse: Copy/clone constructor

A D E G H I O P S T U V