org.apache.beam.examples.complete.cdap.servicenow

Class CdapServiceNowToTxt

java.lang.Object

org.apache.beam.examples.complete.cdap.servicenow.CdapServiceNowToTxt

public class CdapServiceNowToTxt
extends java.lang.Object

The CdapServiceNowToTxt pipeline is a batch pipeline which ingests data in JSON format from CDAP ServiceNow, and outputs the resulting records to .txt file. ServiceNow parameters and output txt file path are specified by the user as template parameters.

Example Usage

 # Gradle preparation

 To run this example your  build.gradle file should contain the following task
 to execute the pipeline:
 
 task executeCdap (type:JavaExec) {
     mainClass = System.getProperty("mainClass")
     classpath = sourceSets.main.runtimeClasspath
     systemProperties System.getProperties()
     args System.getProperty("exec.args", "").split()
 }
 

 This task allows to run the pipeline via the following command:
 
 gradle clean executeCdap -DmainClass=org.apache.beam.examples.complete.cdap.servicenow.CdapServiceNowToTxt \
      -Dexec.args="--<argument>=<value> --<argument>=<value>"
 

 # Running the pipeline
 To execute this pipeline, specify the parameters in the following format:
 
 --clientId=your-client-id \
 --clientSecret=your-client-secret \
 --user=your-user \
 --password=your-password \
 --restApiEndpoint=your-endpoint \
 --queryMode=Table \
 --tableName=your-table \
 --valueType=Actual \
 --referenceName=your-reference-name \
 --outputTxtFilePathPrefix=your-path-to-output-folder-with-filename-prefix
 

 By default this will run the pipeline locally with the DirectRunner. To change the runner, specify:
 
 --runner=YOUR_SELECTED_RUNNER
 
 

Constructor Summary

Constructors

Constructor and Description
CdapServiceNowToTxt()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) Main entry point for pipeline execution.
static org.apache.beam.sdk.PipelineResult	run(org.apache.beam.sdk.Pipeline pipeline, CdapServiceNowOptions options) Runs a pipeline which reads records from CDAP ServiceNow and writes it to .txt file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CdapServiceNowToTxt

public CdapServiceNowToTxt()

Method Detail

main

public static void main(java.lang.String[] args)

Main entry point for pipeline execution.

Parameters:

args - Command line arguments to the pipeline.

run

public static org.apache.beam.sdk.PipelineResult run(org.apache.beam.sdk.Pipeline pipeline,
                                                     CdapServiceNowOptions options)

Runs a pipeline which reads records from CDAP ServiceNow and writes it to .txt file.

Parameters:

options - arguments to the pipeline