org.apache.beam.sdk.options

Class PipelineOptionsValidator

java.lang.Object

org.apache.beam.sdk.options.PipelineOptionsValidator

public class PipelineOptionsValidator
extends java.lang.Object

Validates that the PipelineOptions conforms to all the Validation criteria.

Constructor Summary

Constructors

Constructor and Description
PipelineOptionsValidator()

Method Summary

Modifier and Type	Method and Description
static <T extends PipelineOptions> T	validate(java.lang.Class<T> klass, PipelineOptions options) Validates that the passed PipelineOptions conforms to all the validation criteria from the passed in interface.
static <T extends PipelineOptions> T	validateCli(java.lang.Class<T> klass, PipelineOptions options) Validates that the passed PipelineOptions from command line interface (CLI) conforms to all the validation criteria from the passed in interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineOptionsValidator

public PipelineOptionsValidator()

Method Detail

validate

public static <T extends PipelineOptions> T validate(java.lang.Class<T> klass,
                                                     PipelineOptions options)

Validates that the passed PipelineOptions conforms to all the validation criteria from the passed in interface.

Note that the interface requested must conform to the validation criteria specified on PipelineOptions.as(Class).

Parameters:

klass - The interface to fetch validation criteria from.

options - The PipelineOptions to validate.

Returns:

Validated options.

validateCli

public static <T extends PipelineOptions> T validateCli(java.lang.Class<T> klass,
                                                        PipelineOptions options)

Validates that the passed PipelineOptions from command line interface (CLI) conforms to all the validation criteria from the passed in interface.

Note that the interface requested must conform to the validation criteria specified on PipelineOptions.as(Class).

Parameters:

klass - The interface to fetch validation criteria from.

options - The PipelineOptions to validate.

Returns:

Validated options.