RestServiceConstants (io.cortical:retina-service-rest-model 2.2.1 API)

java.lang.Object
- io.cortical.rest.RestServiceConstants

```
public abstract class RestServiceConstants
extends Object
```
An abstract class for defining the constants of the rest service.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTEXT` Context string to identify context return type.
`static String`	`FINGERPRINT` Fingerprint string to identify fingerprint return type.
`static String`	`FINGERPRINT_ID` Fingerprint_id string to identify Fingerprint_id return type.
`static String`	`IMAGE` Image string to identify image return type.
`static int`	`MAX_RESULTS_LIMIT` Constant for specifying the maximum limit of returned results in generic methods (bitmaps).
`static int`	`MAX_RESULTS_LIMIT_ALLTERMS` Constant for specifying the maximum limit of returned results in get all terms and wildcards and FP_IDs .
`static int`	`MAX_RESULTS_LIMIT_IMAGES` Constant for specifying the maximum limit of returning images.
`static String`	`METRIC` Metric string to identify metric return type.
`static String`	`NULL_API_KEY_MSG`
`static String`	`NULL_BASE_PATH_MSG`
`static String`	`NULL_MODEL_MSG`
`static String`	`NULL_RETINA_MSG` Text constants.
`static String`	`NULL_SERVER_IP_MSG`
`static String`	`NULL_TERM_MSG`
`static String`	`NULL_TEXT_MSG`
`static String`	`PARAM_CONTEXT_ID`
`static String`	`PARAM_FINGERPRINT_ID`
`static String`	`PARAM_FINGERPRINT_NAME`
`static String`	`PARAM_GET_FINGERPRINT`
`static String`	`PARAM_IMAGE_ENCODING`
`static String`	`PARAM_IMAGE_ENCODING_BASE64`
`static String`	`PARAM_IMAGE_ENCODING_BINARY`
`static String`	`PARAM_IMAGE_ENDODING_ALLOWABLE_VALUES`
`static int`	`PARAM_IMAGE_SCALAR_DEFAULT`
`static Color`	`PARAM_INTERNAL_IMAGE_COLOR`
`static Color`	`PARAM_INTERNAL_IMAGE_COLOR_OVERLAY_TERM1`
`static Color`	`PARAM_INTERNAL_IMAGE_COLOR_OVERLAY_TERM2`
`static String`	`PARAM_INTERNAL_IMAGE_SCALAR_CHOOSE`
`static String`	`PARAM_LOGICAL_NAME`
`static String`	`PARAM_MAX_RESULTS`
`static String`	`PARAM_PATH_SIMILARITY_METRIC`
`static String`	`PARAM_PATH_SLICE`
`static String`	`PARAM_PLOT_SCALAR`
`static String`	`PARAM_PLOT_SHAPE`
`static String`	`PARAM_PLOT_SHAPE_ALLOWABLE_VALUES`
`static String`	`PARAM_PLOT_SHAPE_CIRCLE`
`static String`	`PARAM_PLOT_SHAPE_SQUARE`
`static String`	`PARAM_POS_TYPE`
`static String`	`PARAM_POS_TYPES_ALLOWABLE_VALUES`
`static String`	`PARAM_RETINA_NAME` The path parameter referring to the name of a retina.
`static String`	`PARAM_SPARSITY`
`static String`	`PARAM_START_INDEX`
`static String`	`PARAM_TERM`
`static String`	`TAG_IMAGE_PNG`
`static String`	`TERM` Term string to identify term return type.
`static String`	`TEXT` Text, containing a Fingerprint and the actual String.
`static String`	`WORDCLOUD` Word cloud string to identify the word cloud return type.

Constructor Summary

Constructors
Constructor and Description

RestServiceConstants()

Constructors
Constructor and Description
`RestServiceConstants()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NULL_RETINA_MSG
```
public static final String NULL_RETINA_MSG
```
    Text constants.
    
    See Also:
    Constant Field Values
  - NULL_MODEL_MSG
```
public static final String NULL_MODEL_MSG
```
    See Also:
    Constant Field Values
  - NULL_API_KEY_MSG
```
public static final String NULL_API_KEY_MSG
```
    See Also:
    Constant Field Values
  - NULL_BASE_PATH_MSG
```
public static final String NULL_BASE_PATH_MSG
```
    See Also:
    Constant Field Values
  - NULL_SERVER_IP_MSG
```
public static final String NULL_SERVER_IP_MSG
```
    See Also:
    Constant Field Values
  - NULL_TERM_MSG
```
public static final String NULL_TERM_MSG
```
    See Also:
    Constant Field Values
  - NULL_TEXT_MSG
```
public static final String NULL_TEXT_MSG
```
    See Also:
    Constant Field Values
  - PARAM_RETINA_NAME
```
public static final String PARAM_RETINA_NAME
```
    The path parameter referring to the name of a retina.
    
    See Also:
    Constant Field Values
  - PARAM_GET_FINGERPRINT
```
public static final String PARAM_GET_FINGERPRINT
```
    See Also:
    Constant Field Values
  - PARAM_TERM
```
public static final String PARAM_TERM
```
    See Also:
    Constant Field Values
  - PARAM_CONTEXT_ID
```
public static final String PARAM_CONTEXT_ID
```
    See Also:
    Constant Field Values
  - PARAM_START_INDEX
```
public static final String PARAM_START_INDEX
```
    See Also:
    Constant Field Values
  - PARAM_MAX_RESULTS
```
public static final String PARAM_MAX_RESULTS
```
    See Also:
    Constant Field Values
  - PARAM_PLOT_SHAPE
```
public static final String PARAM_PLOT_SHAPE
```
    See Also:
    Constant Field Values
  - PARAM_PLOT_SHAPE_SQUARE
```
public static final String PARAM_PLOT_SHAPE_SQUARE
```
    See Also:
    Constant Field Values
  - PARAM_PLOT_SHAPE_CIRCLE
```
public static final String PARAM_PLOT_SHAPE_CIRCLE
```
    See Also:
    Constant Field Values
  - PARAM_PLOT_SCALAR
```
public static final String PARAM_PLOT_SCALAR
```
    See Also:
    Constant Field Values
  - PARAM_IMAGE_ENCODING
```
public static final String PARAM_IMAGE_ENCODING
```
    See Also:
    Constant Field Values
  - PARAM_IMAGE_ENCODING_BASE64
```
public static final String PARAM_IMAGE_ENCODING_BASE64
```
    See Also:
    Constant Field Values
  - PARAM_IMAGE_ENCODING_BINARY
```
public static final String PARAM_IMAGE_ENCODING_BINARY
```
    See Also:
    Constant Field Values
  - PARAM_IMAGE_ENDODING_ALLOWABLE_VALUES
```
public static final String PARAM_IMAGE_ENDODING_ALLOWABLE_VALUES
```
    See Also:
    Constant Field Values
  - PARAM_SPARSITY
```
public static final String PARAM_SPARSITY
```
    See Also:
    Constant Field Values
  - PARAM_FINGERPRINT_ID
```
public static final String PARAM_FINGERPRINT_ID
```
    See Also:
    Constant Field Values
  - PARAM_LOGICAL_NAME
```
public static final String PARAM_LOGICAL_NAME
```
    See Also:
    Constant Field Values
  - PARAM_PATH_SLICE
```
public static final String PARAM_PATH_SLICE
```
    See Also:
    Constant Field Values
  - PARAM_PATH_SIMILARITY_METRIC
```
public static final String PARAM_PATH_SIMILARITY_METRIC
```
    See Also:
    Constant Field Values
  - PARAM_POS_TYPE
```
public static final String PARAM_POS_TYPE
```
    See Also:
    Constant Field Values
  - PARAM_FINGERPRINT_NAME
```
public static final String PARAM_FINGERPRINT_NAME
```
    See Also:
    Constant Field Values
  - PARAM_IMAGE_SCALAR_DEFAULT
```
public static final int PARAM_IMAGE_SCALAR_DEFAULT
```
    See Also:
    Constant Field Values
  - PARAM_INTERNAL_IMAGE_SCALAR_CHOOSE
```
public static final String PARAM_INTERNAL_IMAGE_SCALAR_CHOOSE
```
    See Also:
    Constant Field Values
  - PARAM_INTERNAL_IMAGE_COLOR
```
public static final Color PARAM_INTERNAL_IMAGE_COLOR
```
  - PARAM_INTERNAL_IMAGE_COLOR_OVERLAY_TERM1
```
public static final Color PARAM_INTERNAL_IMAGE_COLOR_OVERLAY_TERM1
```
  - PARAM_INTERNAL_IMAGE_COLOR_OVERLAY_TERM2
```
public static final Color PARAM_INTERNAL_IMAGE_COLOR_OVERLAY_TERM2
```
  - PARAM_PLOT_SHAPE_ALLOWABLE_VALUES
```
public static final String PARAM_PLOT_SHAPE_ALLOWABLE_VALUES
```
    See Also:
    Constant Field Values
  - TAG_IMAGE_PNG
```
public static final String TAG_IMAGE_PNG
```
    See Also:
    Constant Field Values
  - PARAM_POS_TYPES_ALLOWABLE_VALUES
```
public static final String PARAM_POS_TYPES_ALLOWABLE_VALUES
```
    See Also:
    Constant Field Values
  - MAX_RESULTS_LIMIT_IMAGES
```
public static final int MAX_RESULTS_LIMIT_IMAGES
```
    Constant for specifying the maximum limit of returning images.
    
    See Also:
    Constant Field Values
  - MAX_RESULTS_LIMIT
```
public static final int MAX_RESULTS_LIMIT
```
    Constant for specifying the maximum limit of returned results in generic methods (bitmaps).
    
    See Also:
    Constant Field Values
  - MAX_RESULTS_LIMIT_ALLTERMS
```
public static final int MAX_RESULTS_LIMIT_ALLTERMS
```
    Constant for specifying the maximum limit of returned results in get all terms and wildcards and FP_IDs .
    
    See Also:
    Constant Field Values
  - TERM
```
public static final String TERM
```
    Term string to identify term return type.
    
    See Also:
    Constant Field Values
  - CONTEXT
```
public static final String CONTEXT
```
    Context string to identify context return type.
    
    See Also:
    Constant Field Values
  - FINGERPRINT_ID
```
public static final String FINGERPRINT_ID
```
    Fingerprint_id string to identify Fingerprint_id return type.
    
    See Also:
    Constant Field Values
  - FINGERPRINT
```
public static final String FINGERPRINT
```
    Fingerprint string to identify fingerprint return type.
    
    See Also:
    Constant Field Values
  - METRIC
```
public static final String METRIC
```
    Metric string to identify metric return type.
    
    See Also:
    Constant Field Values
  - IMAGE
```
public static final String IMAGE
```
    Image string to identify image return type.
    
    See Also:
    Constant Field Values
  - WORDCLOUD
```
public static final String WORDCLOUD
```
    Word cloud string to identify the word cloud return type.
    
    See Also:
    Constant Field Values
  - TEXT
```
public static final String TEXT
```
    Text, containing a Fingerprint and the actual String.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - RestServiceConstants
```
public RestServiceConstants()
```

Class RestServiceConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_RETINA_MSG

NULL_MODEL_MSG

NULL_API_KEY_MSG

NULL_BASE_PATH_MSG

NULL_SERVER_IP_MSG

NULL_TERM_MSG

NULL_TEXT_MSG

PARAM_RETINA_NAME

PARAM_GET_FINGERPRINT

PARAM_TERM

PARAM_CONTEXT_ID

PARAM_START_INDEX

PARAM_MAX_RESULTS

PARAM_PLOT_SHAPE

PARAM_PLOT_SHAPE_SQUARE

PARAM_PLOT_SHAPE_CIRCLE

PARAM_PLOT_SCALAR

PARAM_IMAGE_ENCODING

PARAM_IMAGE_ENCODING_BASE64

PARAM_IMAGE_ENCODING_BINARY

PARAM_IMAGE_ENDODING_ALLOWABLE_VALUES

PARAM_SPARSITY

PARAM_FINGERPRINT_ID

PARAM_LOGICAL_NAME

PARAM_PATH_SLICE

PARAM_PATH_SIMILARITY_METRIC

PARAM_POS_TYPE

PARAM_FINGERPRINT_NAME

PARAM_IMAGE_SCALAR_DEFAULT

PARAM_INTERNAL_IMAGE_SCALAR_CHOOSE

PARAM_INTERNAL_IMAGE_COLOR

PARAM_INTERNAL_IMAGE_COLOR_OVERLAY_TERM1

PARAM_INTERNAL_IMAGE_COLOR_OVERLAY_TERM2

PARAM_PLOT_SHAPE_ALLOWABLE_VALUES

TAG_IMAGE_PNG

PARAM_POS_TYPES_ALLOWABLE_VALUES

MAX_RESULTS_LIMIT_IMAGES

MAX_RESULTS_LIMIT

MAX_RESULTS_LIMIT_ALLTERMS

TERM

CONTEXT

FINGERPRINT_ID

FINGERPRINT

METRIC

IMAGE

WORDCLOUD

TEXT

Constructor Detail

RestServiceConstants