SuccessMessageResponse (egeria 5.2-SNAPSHOT API)

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

org.odpi.openmetadata.serveroperations.rest.SuccessMessageResponse

All Implemented Interfaces:: FFDCResponse

public class SuccessMessageResponse extends FFDCResponseBase

SuccessMessageResponse provides the reposnse structure when starting a server.

Constructor Summary

Constructors

Constructor

Description

SuccessMessageResponse()

Default constructor

SuccessMessageResponse(SuccessMessageResponse template)

Copy/clone constructor
Method Summary

Modifier and Type

Method

Description

String

getSuccessMessage()

Return the success message (if any).

void

setSuccessMessage(String successMessage)

Set up the success message.

String

toString()

JSON-like toString

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
equals, getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, hashCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

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

Constructor Details
- SuccessMessageResponse
  
  public SuccessMessageResponse()
  
  Default constructor
- SuccessMessageResponse
  
  public SuccessMessageResponse(SuccessMessageResponse template)
  
  Copy/clone constructor
  
  Parameters:
  
  template - object to copy
Method Details
- getSuccessMessage
  
  public String getSuccessMessage()
  
  Return the success message (if any).
  
  Returns:
  
  string or null
- setSuccessMessage
  
  public void setSuccessMessage(String successMessage)
  
  Set up the success message. This provides supplementary information about the services that have been changed.
  
  Parameters:
  
  successMessage - string or null
- toString
  
  public String toString()
  
  JSON-like toString
  
  Overrides:
  
  toString in class FFDCResponseBase
  
  Returns:
  
  string containing the property names and values