HBase - get row by key and column range
Search form
Description - Gets row by row key and column range
Runtime Class - com.ibi.agents.XDHBaseScanTableByFilterList
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Table: string Name of the table
Batch: integer The max number of rows the scan should return in a batch
Filter List Operator: string Filter List Operator
Select from one of the following options:
- MUST PASS ALL {MUST_PASS_ALL} - MUST PASS ALL
- MUST PASS ONE {MUST_PASS_ONE} - MUST PASS ONE
* - denotes required
Parameter Type Description Row Key: string Row key
Row Key Operator: string Row Key Operator
Select from one of the following options:
- greater than {GREATER} - Greater than
- less than {LESS} - Less than
- equal to {EQUAL} - Equal to
* - denotes required
Parameter Type Description Min Column: string This filter is used for selecting only those keys with columns that are greater than or equal to the minColumn
Min Column Inclusive: boolean This filter is used to specify if the minColumn range is inclusive or not
Max Column: string This filter is used for selecting only those keys with columns that are less than or equal to the maxColumn
Max Column Inclusive: boolean This filter is used to specify if the maxColumn range is inclusive or not
* - denotes required
Parameter Type Description * Type: string Format of the return result document.
Select from one of the following options:
- XML {xml}
- JSON {json}
* - denotes required
Parameter Type Description * Output Document: string Document returned by operation
Select from one of the following options:
- Result Document {result} - Return results of the operation
- Status Document {status} - Return status document
- Input Document {input} - Return the document passed in
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDHBaseScanTableByFilterList
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Table: string Name of the table
Batch: integer The max number of rows the scan should return in a batch
Filter List Operator: string Filter List Operator
Select from one of the following options:
- MUST PASS ALL {MUST_PASS_ALL} - MUST PASS ALL
- MUST PASS ONE {MUST_PASS_ONE} - MUST PASS ONE
* - denotes required
Parameter Type Description Row Key: string Row key
Row Key Operator: string Row Key Operator
Select from one of the following options:
- greater than {GREATER} - Greater than
- less than {LESS} - Less than
- equal to {EQUAL} - Equal to
* - denotes required
Parameter Type Description Min Column: string This filter is used for selecting only those keys with columns that are greater than or equal to the minColumn
Min Column Inclusive: boolean This filter is used to specify if the minColumn range is inclusive or not
Max Column: string This filter is used for selecting only those keys with columns that are less than or equal to the maxColumn
Max Column Inclusive: boolean This filter is used to specify if the maxColumn range is inclusive or not
* - denotes required
Parameter Type Description * Type: string Format of the return result document.
Select from one of the following options:
- XML {xml}
- JSON {json}
* - denotes required
Parameter Type Description * Output Document: string Document returned by operation
Select from one of the following options:
- Result Document {result} - Return results of the operation
- Status Document {status} - Return status document
- Input Document {input} - Return the document passed in
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| Table: | string | Name of the table | Batch: | integer | The max number of rows the scan should return in a batch | Filter List Operator: | string | Filter List Operator
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Row Key: | string | Row key | Row Key Operator: | string | Row Key Operator
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Min Column: | string | This filter is used for selecting only those keys with columns that are greater than or equal to the minColumn | Min Column Inclusive: | boolean | This filter is used to specify if the minColumn range is inclusive or not | Max Column: | string | This filter is used for selecting only those keys with columns that are less than or equal to the maxColumn | Max Column Inclusive: | boolean | This filter is used to specify if the maxColumn range is inclusive or not |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Type: | string | Format of the return result document.
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Output Document: | string | Document returned by operation
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| OnFailConnection | Could not connect to the external system. |
| OnFailRedirection | Redirection status code between 300 and 399. |
| OnFailClientError | Client error status code between 400 and 499. |
| OnFailServerError | Server error status code between 500 and 599. |
| OnFailedOperation | Could not perform the operation requested. |
| OnParseError | Could not parse a document. |
| OnFailLargeRequest | Request entity size exceeds configured maximum. |
| OnFailLargeResponse | Response entity size exceeds configured maximum. |
| OnHTTP-201 Created | The request was successful, we created a new resource and the response body contains the representation. |
| OnHTTP-400 Bad Request | The data given in the POST or PUT failed validation. Inspect the response body for details. |
| OnHTTP-401 Unauthorized | The supplied credentials, if any, are not sufficient to create or update the resource. |
| OnHTTP-404 Not Found | Resource not found. |
| OnHTTP-405 Method Not Allowed | You can't POST or PUT to the resource. |
| OnHTTP-429 Too Many Requests | Your application is sending too many simultaneous requests. |
| OnHTTP-500 Server Error | We couldn't create or update the resource. Please try again. |