Class SearchStringRequestBody
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions
org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions
org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions
org.odpi.openmetadata.frameworks.openmetadata.search.SearchOptions
org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody
- Direct Known Subclasses:
ActivityStatusSearchString
SearchStringRequestBody is the request body structure used on OMAG REST API calls that passes a regular expression
to use as a search string.
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorCopy/clone constructorSearchStringRequestBody
(QueryOptions template) Copy/clone constructorSearchStringRequestBody
(SearchOptions template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the search request.Return the search string parameter name.int
hashCode()
Create a hash code for this element type.void
setSearchString
(String searchString) Set up the search.void
setSearchStringParameterName
(String searchStringParameterName) Set up the search string parameter name.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.SearchOptions
getEndsWith, getIgnoreCase, getStartsWith, setEndsWith, setIgnoreCase, setStartsWith
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions
getAnchorDomainName, getAnchorGUID, getAnchorScopeGUID, getLimitResultsByStatus, getSequencingOrder, getSequencingProperty, setAnchorDomainName, setAnchorGUID, setAnchorScopeGUID, setLimitResultsByStatus, setSequencingOrder, setSequencingProperty
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions
getPageSize, getStartFrom, setPageSize, setStartFrom
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions
getAsOfTime, getGraphQueryDepth, getIncludeOnlyClassifiedElements, getIncludeOnlyRelationships, getMetadataElementSubtypeNames, getMetadataElementTypeName, getRelationshipsPageSize, getSkipClassifiedElements, getSkipRelationships, setAsOfTime, setGraphQueryDepth, setIncludeOnlyClassifiedElements, setIncludeOnlyRelationships, setMetadataElementSubtypeNames, setMetadataElementTypeName, setRelationshipsPageSize, setSkipClassifiedElements, setSkipRelationships
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
getEffectiveTime, getForDuplicateProcessing, getForLineage, getGovernanceZoneFilter, setEffectiveTime, setForDuplicateProcessing, setForLineage, setGovernanceZoneFilter
-
Constructor Details
-
SearchStringRequestBody
public SearchStringRequestBody()Default constructor -
SearchStringRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
SearchStringRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
SearchStringRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getSearchString
Return the search request.- Returns:
- regEx expression
-
setSearchString
Set up the search.- Parameters:
searchString
- regEx expression
-
getSearchStringParameterName
Return the search string parameter name.- Returns:
- string name
-
setSearchStringParameterName
Set up the search string parameter name.- Parameters:
searchStringParameterName
- string name
-
toString
Standard toString method.- Overrides:
toString
in classSearchOptions
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classSearchOptions
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Create a hash code for this element type.- Overrides:
hashCode
in classSearchOptions
- Returns:
- int hash code
-