Package nz.org.riskscape.engine.output

Class PipelineOutputOptions

java.lang.Object
nz.org.riskscape.engine.output.PipelineOutputOptions
public class PipelineOutputOptions extends Object

Contains user specified options to use when saving results from a pipeline execution.

  • Constructor Details

    • PipelineOutputOptions

      public PipelineOutputOptions(@NonNull @NonNull String reference)

  • Method Details

    • setFormat

      public void setFormat(Format newFormat)

    • getReference

      public String getReference()

      A reference to use for the job's output, usually the id of the pipeline or model being run.

    • isReplace

      public boolean isReplace()

      True, if the user would like existing content to be replaced.

    • isChecksum

      public boolean isChecksum()

      True, if the user would like to have a checksum generated for saved results.

    • getFormat

      public Optional<Format> getFormat()

      The format that the user would like applied to all saved results, or empty if no preference was given.

    • getPipelineDeclaration

      public Optional<PipelineDeclaration> getPipelineDeclaration()

      The PipelineDeclaration that the pipeline was realized from, if known. TODO this is probably no longer optional - come back and clean up

    • setReference

      public void setReference(String reference)

      A reference to use for the job's output, usually the id of the pipeline or model being run.

    • setReplace

      public void setReplace(boolean replace)

      True, if the user would like existing content to be replaced.

    • setChecksum

      public void setChecksum(boolean checksum)

      True, if the user would like to have a checksum generated for saved results.

    • setPipelineDeclaration

      public void setPipelineDeclaration(Optional<PipelineDeclaration> pipelineDeclaration)

      The PipelineDeclaration that the pipeline was realized from, if known. TODO this is probably no longer optional - come back and clean up

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object