Package org.apache.beam.sdk.options

Interface PortablePipelineOptions

All Superinterfaces:
FileStagingOptions, HasDisplayData, PipelineOptions
All Known Subinterfaces:
PrismPipelineOptions, SparkPortableStreamingPipelineOptions, TestPortablePipelineOptions, TestPrismPipelineOptions, TestUniversalRunner.Options
public interface PortablePipelineOptions extends PipelineOptions, FileStagingOptions
Pipeline options common to all portable runners.

  • Method Details

    • getJobEndpoint

      @Required String getJobEndpoint()

    • setJobEndpoint

      void setJobEndpoint(String endpoint)

    • getJobServerTimeout

      @Integer(60) int getJobServerTimeout()

    • setJobServerTimeout

      void setJobServerTimeout(int timeout)

    • getDefaultEnvironmentType

      @Nullable String getDefaultEnvironmentType()

    • setDefaultEnvironmentType

      void setDefaultEnvironmentType(String environmentType)

    • getDefaultEnvironmentConfig

      @Nullable String getDefaultEnvironmentConfig()

    • setDefaultEnvironmentConfig

      void setDefaultEnvironmentConfig(@Nullable String config)

    • getSdkWorkerParallelism

      @Integer(1) int getSdkWorkerParallelism()

    • setSdkWorkerParallelism

      void setSdkWorkerParallelism(int parallelism)

    • getEnvironmentCacheMillis

      @Integer(0) int getEnvironmentCacheMillis()

    • setEnvironmentCacheMillis

      void setEnvironmentCacheMillis(int environmentCacheMillis)

    • getEnvironmentExpirationMillis

      @Integer(0) int getEnvironmentExpirationMillis()

    • setEnvironmentExpirationMillis

      void setEnvironmentExpirationMillis(int environmentExpirationMillis)

    • getLoadBalanceBundles

      @Boolean(false) boolean getLoadBalanceBundles()

    • setLoadBalanceBundles

      void setLoadBalanceBundles(boolean loadBalanceBundles)

    • getOutputExecutablePath

      @Nullable String getOutputExecutablePath()

    • setOutputExecutablePath

      void setOutputExecutablePath(String outputExecutablePath)

    • getEnvironmentOptions

      List<String> getEnvironmentOptions()

    • setEnvironmentOptions

      void setEnvironmentOptions(List<String> value)

    • getEnvironmentOption

      static String getEnvironmentOption(PortablePipelineOptions options, String environmentOptionName)
      Return the value for the specified environment option or empty string if not present.

    • getEnableHeapDumps

      @Boolean(false) boolean getEnableHeapDumps()
      If true and PipelineOption tempLocation is set, save a heap dump before shutting down the JVM due to GC thrashing or out of memory. The heap will be dumped to local disk and then uploaded to the tempLocation.

      CAUTION: Heap dumps can take up more disk than the JVM memory. Ensure the local disk is configured to have sufficient free space before enabling this option.

    • setEnableHeapDumps

      void setEnableHeapDumps(boolean enableHeapDumps)