Coding Guidelines
The following coding guidelines help the user while implementing Custom Service Health Check method.
Bean: CustomComponentResponse
Contained Element | Type and Setter | Description |
---|---|---|
CustomInnerComponent
|
|
As it is a list,
getCustomInnerComponent() on an Object of
CustomComponentResponse
returns a reference list. In the list, you can add an Object instance of
CustomInnerComponent.
|
CustomComponentReference
|
|
As it is a list,
GetCustomComponentReference()
on an Object of
CustomComponentResponse returns a reference list. In the list, you can add an Object instance of
CustomComponentReference .
|
CustomSharedResource
|
|
As it is a list,
GetCustomSharedResource() on an Object of
CustomComponentResponse returns a reference list. In the list, you can add an Object instance of
CustomSharedResource. |
Error
|
|
Creates Object instance of
CustomError and the instance can be set in
CustomComponentResponse using the
set method.
|
status
|
|
Possible Values are
CustomStatus.PASSED ,
CustomStatus.FAILED ,
CustomStatus.TIMEOUT .
|
description
|
|
Simple string set method for the string field. |
Bean: CustomComponentReference
Contained Element | Type and Setter | Description |
---|---|---|
Error
|
Simple/Complex:
Complex Type: Setter:
|
Creates Object instance of
CustomError and the instance can be set in
CustomComponentResponse using the
set method.
|
name
|
Simple/Complex:
Simple Type:
Setter: |
Simple string set method for the string field. |
status
|
Simple/Complex:
Simple
Type:
Enum
Setter:
|
Possible Values are
CustomStatus.PASSED ,
CustomStatus.FAILED ,
CustomStatus.TIMEOUT |
description
|
Simple/Complex:
Simple Type: Setter:
|
Simple string set method for the string field. |
Bean: CustomInnerComponent
Contained Element | Type and Setter | Description |
---|---|---|
Error
|
Simple/Complex:
Complex
Type:
Setter: |
Creates Object instance of
CustomError and the instance can be set in
CustomComponentResponse using the
set method.
|
name
|
Simple/Complex:
Simple Type: Setter:
|
Simple string set method for the string field. |
description
|
Simple/Complex:
Simple Type:
Setter: |
Simple string set method for the string field. |
status
|
Simple/Complex:
Simple Type:
Setter:
|
Possible Values are
CustomStatus.PASSED ,
CustomStatus.FAILED ,
CustomStatus.TIMEOUT |
Bean: CustomSharedResource
Contained Element | Type and Setter | Description |
---|---|---|
Error
|
Simple/Complex:
Complex Type:
Setter:
|
Creates Object instance of
CustomError and the instance can be set in
CustomComponentResponse using the
set method.
|
name
|
Simple/Complex:
Simple Type:
Setter:
|
Simple string set method for the string field. |
resourceName
|
Simple/Complex:
Simple Type:
Setter:
|
Simple string set method for the string field. |
resourceType
|
Simple/Complex:
Simple Type:
Setter:
|
Simple string set method for the string field. |
status
|
Simple/Complex:
Simple Type:
Setter:
|
Possible Values are
CustomStatus.PASSED ,
CustomStatus.FAILED ,
CustomStatus.TIMEOUT |
description
|
Simple/Complex:
Simple Type:
Setter:
|
Simple string set method for the string field. |
Bean: CustomError
Contained Element | Type and Setter | Description |
---|---|---|
errorCode
|
Simple/Complex:
Simple Type:
Setter:
|
Simple string set method for the string field. |
errorString
|
Simple/Complex:
Simple Type:
Setter:
|
Simple string set method for the string field. |
stackTrace
|
Simple/Complex:
Simple Type:
Setter:
|
Simple string set method for the string field. |