Class RequestParameterType
java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.controls.RequestParameterType
RequestParameterType characterises one of the request parameters supported by a specific governance service.
This enables the capability of a governance service to be correctly matched to the resources and
elements that it works with.
-
Constructor Summary
ConstructorDescriptionDefault constructorRequestParameterType
(RequestParameterType template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Return comparison result based on the content of the properties.Return the data type name for the parameter value.Return the description of the request parameter.Return an example parameter value.getName()
Return the string to use as the name of the request parameter.Return a map of property name to property value to provide additional information for this governance service.boolean
Return whether this request parameter is required for this service to work successful.int
hashCode()
Return hash code for this objectvoid
setDataType
(String dataType) Set up data type name for the parameter value.void
setDescription
(String description) Set up the description of the request parameter.void
setExample
(String example) Set up an example parameter value.void
Set up the string to use as the name of the request parameter.void
setOtherPropertyValues
(Map<String, String> otherPropertyValues) Set up a map of property name to property value to provide additional information for this governance service.void
setRequired
(boolean required) Set up whether this request parameter is required for this service to work successful.toString()
JSON-style toString
-
Constructor Details
-
RequestParameterType
public RequestParameterType()Default constructor -
RequestParameterType
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getName
Return the string to use as the name of the request parameter.- Returns:
- string name
-
setName
Set up the string to use as the name of the request parameter.- Parameters:
name
- string name
-
getDescription
Return the description of the request parameter.- Returns:
- string
-
setDescription
Set up the description of the request parameter.- Parameters:
description
- string
-
getDataType
Return the data type name for the parameter value.- Returns:
- data type
-
setDataType
Set up data type name for the parameter value.- Parameters:
dataType
- data type
-
getExample
Return an example parameter value.- Returns:
- string
-
setExample
Set up an example parameter value.- Parameters:
example
- string
-
getRequired
public boolean getRequired()Return whether this request parameter is required for this service to work successful.- Returns:
- boolean flag
-
setRequired
public void setRequired(boolean required) Set up whether this request parameter is required for this service to work successful.- Parameters:
required
- boolean flag
-
getOtherPropertyValues
Return a map of property name to property value to provide additional information for this governance service.- Returns:
- map of string to string
-
setOtherPropertyValues
Set up a map of property name to property value to provide additional information for this governance service.- Parameters:
otherPropertyValues
- map of string to string
-
toString
JSON-style toString -
equals
Return comparison result based on the content of the properties. -
hashCode
public int hashCode()Return hash code for this object
-