Interface TimeseriesItem.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TimeseriesItem.Builder,TimeseriesItem>, SdkBuilder<TimeseriesItem.Builder,TimeseriesItem>, SdkPojo
Enclosing class:
TimeseriesItem
@Mutable @NotThreadSafe public static interface TimeseriesItem.Builder extends SdkPojo, CopyableBuilder<TimeseriesItem.Builder,TimeseriesItem>

  • Method Details

    • timeSeriesId

      TimeseriesItem.Builder timeSeriesId(String timeSeriesId)
      <p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>
      Parameters:
      timeSeriesId - <p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • propertyAlias

      TimeseriesItem.Builder propertyAlias(String propertyAlias)
      <p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>
      Parameters:
      propertyAlias - <p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trimSettings

      TimeseriesItem.Builder trimSettings(TrimSettings trimSettings)
      <p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>
      Parameters:
      trimSettings - <p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trimSettings

      default TimeseriesItem.Builder trimSettings(Consumer<TrimSettings.Builder> trimSettings)
      <p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p> This is a convenience method that creates an instance of the TrimSettings.Builder avoiding the need to create one manually via TrimSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trimSettings(TrimSettings).

      Parameters:
      trimSettings - a consumer that will call methods on TrimSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • formatSettings

      TimeseriesItem.Builder formatSettings(FormatSettings formatSettings)
      <p>The optional format settings for the output.</p>
      Parameters:
      formatSettings - <p>The optional format settings for the output.</p>
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • formatSettings

      default TimeseriesItem.Builder formatSettings(Consumer<FormatSettings.Builder> formatSettings)
      <p>The optional format settings for the output.</p> This is a convenience method that creates an instance of the FormatSettings.Builder avoiding the need to create one manually via FormatSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to formatSettings(FormatSettings).

      Parameters:
      formatSettings - a consumer that will call methods on FormatSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: