hbase connector

Description - Get rows by row key prefix
 
Runtime Class - com.ibi.agents.XDHBaseScanTableByPrefixFilter

 

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
  Row Key Prefix: string Prefix of row key
* - 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

 

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.
Description - Get rows by page size

Runtime Class - com.ibi.agents.XDHBaseScanTableByPageFilter


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
Size:integerIt is used to limits results to the specific page size
* - 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 rows by multiple column prefixes

Runtime Class - com.ibi.agents.XDHBaseScanTableByMultipleColumnPrefixFilter


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
Table of Column Prefix:Table (as described below) Table of Column Prefix
* - denotes required

Table of Column Prefix:
 ColumnTypeDescription
Column PrefixstringColumn Prefix
* - 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 Prefix:
 ColumnTypeDescription
Column PrefixstringColumn Prefix
* - 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 Prefix:
 ColumnTypeDescription
Column PrefixstringColumn Prefix
* - 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 rows by inclusive stop

Runtime Class - com.ibi.agents.XDHBaseScanTableByInclusiveStopFilter


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:stringA Filter that stops after the given row key
* - 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 rows by first key Only

Runtime Class - com.ibi.agents.XDHBaseScanTableByFirstKeyOnlyFilter


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
* - 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 rows by column range

Runtime Class - com.ibi.agents.XDHBaseScanTableByColumnRangeFilter


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
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 rows by column qualifier

Runtime Class - com.ibi.agents.XDHBaseScanTableByQualifierFilter


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
Column Qualifier:stringA column qualifier
Operator:stringThis filter takes the operator for the column qualifier portion 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 - Get rows by column prefix

Runtime Class - com.ibi.agents.XDHBaseScanTableByColumnPrefixFilter


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
Column Prefix:stringThis filter is used for selecting only those keys with columns that matches a particular 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 - Get rows by column family

Runtime Class - com.ibi.agents.XDHBaseScanTableByFamilyFilter


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
Column Family:stringThis filter is used to filter based on the column family
Operator:stringThis filter takes the operator for the column family portion 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 - Get rows between two timestamps

Runtime Class - com.ibi.agents.XDHBaseGetTableInfoBetweenTimes


Configuration

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

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
Start Timestamp:integerStart Timestamp
End Timestamp:integerEnd Timestamp
* - 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.