PipelineOptionsFactory (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

Warning: Cloud Dataflow SDK 1.x for Java is unsupported as of October 16, 2018. See Migrating from Cloud Dataflow SDK 1.x for Java for migration guidance.

Note: If you are using Cloud Dataflow SDK version 2.x, see the Apache Beam API reference documentation.

com.google.cloud.dataflow.sdk.options

Class PipelineOptionsFactory

• java.lang.Object
• • com.google.cloud.dataflow.sdk.options.PipelineOptionsFactory

• ---

  
  

  public class PipelineOptionsFactory
  extends Object

  Constructs a PipelineOptions or any derived interface that is composable to any other derived interface of PipelineOptions via the PipelineOptions.as(java.lang.Class<T>) method. Being able to compose one derived interface of PipelineOptions to another has the following restrictions:

  • Any property with the same name must have the same return type for all derived interfaces of PipelineOptions.
  • Every bean property of any interface derived from PipelineOptions must have a getter and setter method.
  • Every method must conform to being a getter or setter for a JavaBean.
  • The derived interface of PipelineOptions must be composable with every interface registered with this factory.

  See the JavaBeans specification for more details as to what constitutes a property.

• • Nested Class Summary

    Nested Classes 

    Modifier and Type	Class and Description
    static class	PipelineOptionsFactory.Builder A fluent PipelineOptions builder.

  • Constructor Summary

    Constructors 

    Constructor and Description
    PipelineOptionsFactory()

  • Method Summary

    All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 

    Modifier and Type	Method and Description
    static <T extends PipelineOptions> T	as(Class<T> klass) Creates and returns an object that implements <T>.
    static PipelineOptions	create() Creates and returns an object that implements PipelineOptions.
    static DataflowWorkerHarnessOptions	createFromSystemProperties() Deprecated.  for internal use only
    static DataflowWorkerHarnessOptions	createFromSystemPropertiesInternal() Creates a set of Dataflow worker harness options based of a set of known system properties.
    static PipelineOptionsFactory.Builder	fromArgs(String[] args) Sets the command line arguments to parse when constructing the PipelineOptions.
    static Set<Class<? extends PipelineOptions>>	getRegisteredOptions()
    static void	printHelp(PrintStream out) Outputs the set of registered options with the PipelineOptionsFactory with a description for each one if available to the output stream.
    static void	printHelp(PrintStream out, Class<? extends PipelineOptions> iface) Outputs the set of options available to be set for the passed in PipelineOptions interface.
    static void	register(Class<? extends PipelineOptions> iface) This registers the interface with this factory.
    PipelineOptionsFactory.Builder	withValidation() After creation we will validate that <T> conforms to all the validation criteria.

    • Methods inherited from class java.lang.Object

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

• • Constructor Detail

    • PipelineOptionsFactory

      public PipelineOptionsFactory()

  • Method Detail

    • create

      public static PipelineOptions create()

      Creates and returns an object that implements PipelineOptions. This sets the "appName" to the calling classes simple name.

      Returns:

      An object that implements PipelineOptions.

    • as

      public static <T extends PipelineOptions> T as(Class<T> klass)

      Creates and returns an object that implements <T>. This sets the "appName" to the calling classes simple name.

      Note that <T> must be composable with every registered interface with this factory. See validateWellFormed(Class, Set) for more details.

      Returns:

      An object that implements <T>.

    • fromArgs

      public static PipelineOptionsFactory.Builder fromArgs(String[] args)

      Sets the command line arguments to parse when constructing the PipelineOptions.

      Example GNU style command line arguments:

         --project=MyProject (simple property, will set the "project" property to "MyProject")
         --readOnly=true (for boolean properties, will set the "readOnly" property to "true")
         --readOnly (shorthand for boolean properties, will set the "readOnly" property to "true")
         --x=1 --x=2 --x=3 (list style simple property, will set the "x" property to [1, 2, 3])
         --x=1,2,3 (shorthand list style simple property, will set the "x" property to [1, 2, 3])
         --complexObject='{"key1":"value1",...} (JSON format for all other complex types)
       

      Simple properties are able to bound to String, Class, enums and Java primitives boolean, byte, short, int, long, float, double and their primitive wrapper classes.

      Simple list style properties are able to be bound to boolean[], char[], short[], int[], long[], float[], double[], Class[], enum arrays, String[], and List<String>.

      JSON format is required for all other types.

      By default, strict parsing is enabled and arguments must conform to be either --booleanArgName or --argName=argValue. Strict parsing can be disabled with PipelineOptionsFactory.Builder.withoutStrictParsing(). Empty or null arguments will be ignored whether or not strict parsing is enabled.

      Help information can be output to System.out by specifying --help as an argument. After help is printed, the application will exit. Specifying only --help will print out the list of registered options by invoking printHelp(PrintStream). Specifying --help=PipelineOptionsClassName will print out detailed usage information about the specifically requested PipelineOptions by invoking printHelp(PrintStream, Class).

    • withValidation

      public PipelineOptionsFactory.Builder withValidation()

      After creation we will validate that <T> conforms to all the validation criteria. See PipelineOptionsValidator.validate(Class, PipelineOptions) for more details about validation.

    • register

      public static void register(Class<? extends PipelineOptions> iface)

      This registers the interface with this factory. This interface must conform to the following restrictions:

      • Any property with the same name must have the same return type for all derived interfaces of PipelineOptions.
      • Every bean property of any interface derived from PipelineOptions must have a getter and setter method.
      • Every method must conform to being a getter or setter for a JavaBean.
      • The derived interface of PipelineOptions must be composable with every interface registered with this factory.

      Parameters:

      iface - The interface object to manually register.

    • getRegisteredOptions

      public static Set<Class<? extends PipelineOptions>> getRegisteredOptions()

    • printHelp

      public static void printHelp(PrintStream out)

      Outputs the set of registered options with the PipelineOptionsFactory with a description for each one if available to the output stream. This output is pretty printed and meant to be human readable. This method will attempt to format its output to be compatible with a terminal window.

    • printHelp

      public static void printHelp(PrintStream out,
                                   Class<? extends PipelineOptions> iface)

      Outputs the set of options available to be set for the passed in PipelineOptions interface. The output is in a human readable format. The format is:

       OptionGroup:
           ... option group description ...
      
        --option1= <type> or list of valid enum choices
           Default: value (if available, see Default)
           ... option description ... (if available, see Description)
           Required groups (if available, see Validation.Required)
        --option2= <type> or list of valid enum choices
           Default: value (if available, see Default)
           ... option description ... (if available, see Description)
           Required groups (if available, see Validation.Required)
       

      This method will attempt to format its output to be compatible with a terminal window.

    • createFromSystemPropertiesInternal

      public static DataflowWorkerHarnessOptions createFromSystemPropertiesInternal()
                                                                             throws IOException

      Creates a set of Dataflow worker harness options based of a set of known system properties. This is meant to only be used from the Dataflow worker harness as a method to bootstrap the worker harness.

      For internal use only.

      Returns:

      A DataflowWorkerHarnessOptions object configured for the Dataflow worker harness.

      Throws:

      IOException

    • createFromSystemProperties

      @Deprecated
      public static DataflowWorkerHarnessOptions createFromSystemProperties()
                                                                                 throws IOException

      Deprecated. for internal use only
      Creates a set of DataflowWorkerHarnessOptions based of a set of known system properties. This is meant to only be used from the Dataflow worker harness as a method to bootstrap the worker harness.

      Returns:

      A DataflowWorkerHarnessOptions object configured for the Dataflow worker harness.

      Throws:

      IOException