Package com._1c.g5.v8.derived.v2.pipeline

Class DerivedDataSegmentDefinitionV2

java.lang.Object
com._1c.g5.v8.derived.v2.pipeline.DerivedDataSegmentDefinitionV2
public final class DerivedDataSegmentDefinitionV2 extends Object
Derived data segment definition which uses segment dependencies to define its placement in the pipeline

  • Constructor Details

    • DerivedDataSegmentDefinitionV2

      public DerivedDataSegmentDefinitionV2(String segmentId, DerivedDataSegmentBucket preferredSegment, DerivedDataSegmentConcurrencyStrategy concurrency, boolean operationSegment, String segmentName, String segmentStatusTemplate, boolean longRunningSegment, Set<String> dependsOn)
      Creates an instance of the DD pipeline segment definition.
      Parameters:
      segmentId - The identifier of the segment. Cannot be null. Must be globally unique
      preferredSegment - The preferred DD pipeline segment. Non-priority tasks will be placed in this bucket. Cannot be null
      concurrency - The concurrency policy of the computation. Cannot be null
      operationSegment - The managed operation segment flag
      segmentName - The user-readable segment name. Cannot be null
      segmentStatusTemplate - The computation status template for the rendering. Cannot be null
      longRunningSegment - Designates that the segment is long-running one so it needs special indication
      dependsOn - The set of segments the current segments depends on. Cannot be null

    • DerivedDataSegmentDefinitionV2

      public DerivedDataSegmentDefinitionV2(String segmentId, DerivedDataSegmentBucket preferredSegment, DerivedDataSegmentConcurrencyStrategy concurrency, String segmentName, String segmentStatusTemplate, Set<String> dependsOn)
      Creates an instance of the DD pipeline data segment definition
      Parameters:
      segmentId - The identifier of the segment. Cannot be null. Must be globally unique
      preferredSegment - The preferred DD pipeline segment. Non-priority tasks will be placed in this bucket. Cannot be null
      concurrency - The concurrency policy of the computation. Cannot be null
      segmentName - The user-readable segment name. Cannot be null
      segmentStatusTemplate - The computation status template for the rendering. Cannot be null
      dependsOn - The set of segments the current segments depends on. Cannot be null

  • Method Details

    • getPreferredStage

      public DerivedDataSegmentBucket getPreferredStage()
      Gets the preferred async. pipeline execution stage for this segment
      Returns:
      The pipeline stage. Cannot be null

    • getConcurrency

      public DerivedDataSegmentConcurrencyStrategy getConcurrency()
      Gets the concurrency policy for the segment
      Returns:
      The concurrency policy. Cannot be null

    • getSegmentId

      public String getSegmentId()
      Gets the segment identifier for this segment. Must be globally unique
      Returns:
      The segment unique identifier. Cannot be null

    • getSegmentName

      public String getSegmentName()
      Gets a human-readable name of the segment
      Returns:
      The name of the segment. Cannot be null

    • getSegmentStatusTemplate

      public String getSegmentStatusTemplate()
      Gets the human-readable template which is used to display the progress of the segment data computation. During the status displaying the async. computation subsystem supplies two parameters which may be used in this template - current number of computed units and the total number of registered computation units
      Returns:
      The segment status template. Cannot be null

    • isLongRunningSegment

      public boolean isLongRunningSegment()
      Checks if this segment is a long-running one. Long-running segments have no exact progress indicator and their progress is being displayed as a cycling indicator
      Returns:
      True if the segmet is a long-runnig one

    • getDependsOn

      public Set<String> getDependsOn()
      Gets the set of dependencies for this segment
      Returns:
      The set of segments the current segment depends on. Cannot be null

    • isOperationSegment

      public boolean isOperationSegment()
      Checks if this segment is an operation one
      Returns:
      True if the segment is an operation segment