hbase connector

Description - Get rows between two row key prefixs

Runtime Class - com.ibi.agents.XDHBaseScanTableByTwoPrefixFilters


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
Start Row Key Prefix:stringStart row key prefix
End Row Key Prefix:stringEnd row key prefix
* - denotes required
 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Gets row by row key

Runtime Class - com.ibi.agents.XDHBaseScanTableByRowFilter


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
Batch:integerThe max number of rows the scan should return in a batch
Row Key:stringRow key
Operator:stringThis filter takes the operator for the row, and column qualifier portions of a key.

Select from one of the following options:
  • greater than {GREATER}
  • less than {LESS}
  • equal to {EQUAL}
* - denotes required
 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
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

 ParameterTypeDescription
Table:stringName of the table
Batch:integerThe max number of rows the scan should return in a batch
Filter List Operator:stringFilter 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
 ParameterTypeDescription
Row Key:stringRow key
Row Key Operator:stringRow 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
 ParameterTypeDescription
Min Column:stringThis filter is used for selecting only those keys with columns that are greater than or equal to the minColumn
Min Column Inclusive:booleanThis filter is used to specify if the minColumn range is inclusive or not
Max Column:stringThis filter is used for selecting only those keys with columns that are less than or equal to the maxColumn
Max Column Inclusive:booleanThis filter is used to specify if the maxColumn range is inclusive or not
* - denotes required
 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Get list of table regions

Runtime Class - com.ibi.agents.XDHBaseTableRegionList


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
* - denotes required
 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
  • TEXT {text}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Get list of all tables in a specific namespace

Runtime Class - com.ibi.agents.XDHBaseTableListwithNamespace


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Namespace:stringName of specific namespace
* - denotes required
 ParameterTypeDescription
Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
  • TEXT {text}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Get list of all non-system tables

Runtime Class - com.ibi.agents.XDHBaseTableList


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
  • TEXT {text}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Get list of all namespaces

Runtime Class - com.ibi.agents.XDHBaseNamespaceList


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
  • TEXT {text}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Describe the schema of the specified table

Runtime Class - com.ibi.agents.XDHBaseSchemaofTable


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the specified table
* - denotes required
 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
  • TEXT {text}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Describe a specific namespace

Runtime Class - com.ibi.agents.XDHBaseDescribeNamespace


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Namespace:stringName of specific namespace
* - denotes required
 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
  • TEXT {text}
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Get column(s) by specified column(s)

Runtime Class - com.ibi.agents.XDHBaseGetTableInfoByColumns


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
Table of Column:Table (as described below) Table of column. By default, all rows will be returned if the table of column is empty.
* - denotes required

Table of Column:
 ColumnTypeDescription
ColumnstringColumn family with qualifer(family:qualifer)
* - denotes required
 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required

Table of Column:
 ColumnTypeDescription
ColumnstringColumn family with qualifer(family:qualifer)
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument 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

Table of Column:
 ColumnTypeDescription
ColumnstringColumn family with qualifer(family:qualifer)
* - denotes required

Output Events

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.