Class StartStreamingJobParameters


  • public final class StartStreamingJobParameters
    extends Object
    Parameters supplied to the Start Streaming Job operation.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      OutputStartMode outputStartMode()
      Get the outputStartMode property: Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.
      OffsetDateTime outputStartTime()
      Get the outputStartTime property: Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started.
      void validate()
      Validates the instance.
      StartStreamingJobParameters withOutputStartMode​(OutputStartMode outputStartMode)
      Set the outputStartMode property: Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.
      StartStreamingJobParameters withOutputStartTime​(OffsetDateTime outputStartTime)
      Set the outputStartTime property: Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started.
    • Constructor Detail

      • StartStreamingJobParameters

        public StartStreamingJobParameters()
    • Method Detail

      • outputStartMode

        public OutputStartMode outputStartMode()
        Get the outputStartMode property: Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.
        Returns:
        the outputStartMode value.
      • withOutputStartMode

        public StartStreamingJobParameters withOutputStartMode​(OutputStartMode outputStartMode)
        Set the outputStartMode property: Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.
        Parameters:
        outputStartMode - the outputStartMode value to set.
        Returns:
        the StartStreamingJobParameters object itself.
      • outputStartTime

        public OffsetDateTime outputStartTime()
        Get the outputStartTime property: Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.
        Returns:
        the outputStartTime value.
      • withOutputStartTime

        public StartStreamingJobParameters withOutputStartTime​(OffsetDateTime outputStartTime)
        Set the outputStartTime property: Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.
        Parameters:
        outputStartTime - the outputStartTime value to set.
        Returns:
        the StartStreamingJobParameters object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.