Package gauge.messages

Interface Spec.ProtoScenarioOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Spec.ProtoScenario, Spec.ProtoScenario.Builder
Enclosing class:
Spec
public static interface Spec.ProtoScenarioOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getScenarioHeading

      String getScenarioHeading()
       / Heading of the given Scenario
      string scenarioHeading = 1;
      Returns:
      The scenarioHeading.

    • getScenarioHeadingBytes

      com.google.protobuf.ByteString getScenarioHeadingBytes()
       / Heading of the given Scenario
      string scenarioHeading = 1;
      Returns:
      The bytes for scenarioHeading.

    • getFailed

      @Deprecated boolean getFailed()
      Deprecated.
      gauge.messages.ProtoScenario.failed is deprecated. See spec.proto;l=99
       / Flag to indicate if the Scenario execution failed
      bool failed = 2 [deprecated = true];
      Returns:
      The failed.

    • getContextsList

      List<Spec.ProtoItem> getContextsList()
       / Collection of Context steps. The Context steps are executed before every run.
      repeated .gauge.messages.ProtoItem contexts = 3;

    • getContexts

      Spec.ProtoItem getContexts(int index)
       / Collection of Context steps. The Context steps are executed before every run.
      repeated .gauge.messages.ProtoItem contexts = 3;

    • getContextsCount

      int getContextsCount()
       / Collection of Context steps. The Context steps are executed before every run.
      repeated .gauge.messages.ProtoItem contexts = 3;

    • getContextsOrBuilderList

      List<? extends Spec.ProtoItemOrBuilder> getContextsOrBuilderList()
       / Collection of Context steps. The Context steps are executed before every run.
      repeated .gauge.messages.ProtoItem contexts = 3;

    • getContextsOrBuilder

      Spec.ProtoItemOrBuilder getContextsOrBuilder(int index)
       / Collection of Context steps. The Context steps are executed before every run.
      repeated .gauge.messages.ProtoItem contexts = 3;

    • getScenarioItemsList

      List<Spec.ProtoItem> getScenarioItemsList()
       / Collection of Items under a scenario. These could be Steps, Comments, Tags, TableDrivenScenarios or Tables
      repeated .gauge.messages.ProtoItem scenarioItems = 4;

    • getScenarioItems

      Spec.ProtoItem getScenarioItems(int index)
       / Collection of Items under a scenario. These could be Steps, Comments, Tags, TableDrivenScenarios or Tables
      repeated .gauge.messages.ProtoItem scenarioItems = 4;

    • getScenarioItemsCount

      int getScenarioItemsCount()
       / Collection of Items under a scenario. These could be Steps, Comments, Tags, TableDrivenScenarios or Tables
      repeated .gauge.messages.ProtoItem scenarioItems = 4;

    • getScenarioItemsOrBuilderList

      List<? extends Spec.ProtoItemOrBuilder> getScenarioItemsOrBuilderList()
       / Collection of Items under a scenario. These could be Steps, Comments, Tags, TableDrivenScenarios or Tables
      repeated .gauge.messages.ProtoItem scenarioItems = 4;

    • getScenarioItemsOrBuilder

      Spec.ProtoItemOrBuilder getScenarioItemsOrBuilder(int index)
       / Collection of Items under a scenario. These could be Steps, Comments, Tags, TableDrivenScenarios or Tables
      repeated .gauge.messages.ProtoItem scenarioItems = 4;

    • hasPreHookFailure

      boolean hasPreHookFailure()
       / Contains a 'before' hook failure message. This happens when the `before_scenario` hook has an error.
      .gauge.messages.ProtoHookFailure preHookFailure = 5;
      Returns:
      Whether the preHookFailure field is set.

    • getPreHookFailure

      Spec.ProtoHookFailure getPreHookFailure()
       / Contains a 'before' hook failure message. This happens when the `before_scenario` hook has an error.
      .gauge.messages.ProtoHookFailure preHookFailure = 5;
      Returns:
      The preHookFailure.

    • getPreHookFailureOrBuilder

      Spec.ProtoHookFailureOrBuilder getPreHookFailureOrBuilder()
       / Contains a 'before' hook failure message. This happens when the `before_scenario` hook has an error.
      .gauge.messages.ProtoHookFailure preHookFailure = 5;

    • hasPostHookFailure

      boolean hasPostHookFailure()
       / Contains a 'after' hook failure message. This happens when the `after_scenario` hook has an error.
      .gauge.messages.ProtoHookFailure postHookFailure = 6;
      Returns:
      Whether the postHookFailure field is set.

    • getPostHookFailure

      Spec.ProtoHookFailure getPostHookFailure()
       / Contains a 'after' hook failure message. This happens when the `after_scenario` hook has an error.
      .gauge.messages.ProtoHookFailure postHookFailure = 6;
      Returns:
      The postHookFailure.

    • getPostHookFailureOrBuilder

      Spec.ProtoHookFailureOrBuilder getPostHookFailureOrBuilder()
       / Contains a 'after' hook failure message. This happens when the `after_scenario` hook has an error.
      .gauge.messages.ProtoHookFailure postHookFailure = 6;

    • getTagsList

      List<String> getTagsList()
       / Contains a list of tags that are defined at the specification level. Scenario tags are not present here.
      repeated string tags = 7;
      Returns:
      A list containing the tags.

    • getTagsCount

      int getTagsCount()
       / Contains a list of tags that are defined at the specification level. Scenario tags are not present here.
      repeated string tags = 7;
      Returns:
      The count of tags.

    • getTags

      String getTags(int index)
       / Contains a list of tags that are defined at the specification level. Scenario tags are not present here.
      repeated string tags = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The tags at the given index.

    • getTagsBytes

      com.google.protobuf.ByteString getTagsBytes(int index)
       / Contains a list of tags that are defined at the specification level. Scenario tags are not present here.
      repeated string tags = 7;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.

    • getExecutionTime

      long getExecutionTime()
       / Holds the time taken for executing this scenario.
      int64 executionTime = 8;
      Returns:
      The executionTime.

    • getSkipped

      @Deprecated boolean getSkipped()
      Deprecated.
      gauge.messages.ProtoScenario.skipped is deprecated. See spec.proto;l=113
       / Flag to indicate if the Scenario execution is skipped
      bool skipped = 9 [deprecated = true];
      Returns:
      The skipped.

    • getSkipErrorsList

      List<String> getSkipErrorsList()
       / Holds the error messages for skipping scenario from execution
      repeated string skipErrors = 10;
      Returns:
      A list containing the skipErrors.

    • getSkipErrorsCount

      int getSkipErrorsCount()
       / Holds the error messages for skipping scenario from execution
      repeated string skipErrors = 10;
      Returns:
      The count of skipErrors.

    • getSkipErrors

      String getSkipErrors(int index)
       / Holds the error messages for skipping scenario from execution
      repeated string skipErrors = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The skipErrors at the given index.

    • getSkipErrorsBytes

      com.google.protobuf.ByteString getSkipErrorsBytes(int index)
       / Holds the error messages for skipping scenario from execution
      repeated string skipErrors = 10;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the skipErrors at the given index.

    • getID

      String getID()
       / Holds the unique Identifier of a scenario.
      string ID = 11;
      Returns:
      The iD.

    • getIDBytes

      com.google.protobuf.ByteString getIDBytes()
       / Holds the unique Identifier of a scenario.
      string ID = 11;
      Returns:
      The bytes for iD.

    • getTearDownStepsList

      List<Spec.ProtoItem> getTearDownStepsList()
       / Collection of Teardown steps. The Teardown steps are executed after every run.
      repeated .gauge.messages.ProtoItem tearDownSteps = 12;

    • getTearDownSteps

      Spec.ProtoItem getTearDownSteps(int index)
       / Collection of Teardown steps. The Teardown steps are executed after every run.
      repeated .gauge.messages.ProtoItem tearDownSteps = 12;

    • getTearDownStepsCount

      int getTearDownStepsCount()
       / Collection of Teardown steps. The Teardown steps are executed after every run.
      repeated .gauge.messages.ProtoItem tearDownSteps = 12;

    • getTearDownStepsOrBuilderList

      List<? extends Spec.ProtoItemOrBuilder> getTearDownStepsOrBuilderList()
       / Collection of Teardown steps. The Teardown steps are executed after every run.
      repeated .gauge.messages.ProtoItem tearDownSteps = 12;

    • getTearDownStepsOrBuilder

      Spec.ProtoItemOrBuilder getTearDownStepsOrBuilder(int index)
       / Collection of Teardown steps. The Teardown steps are executed after every run.
      repeated .gauge.messages.ProtoItem tearDownSteps = 12;

    • hasSpan

      boolean hasSpan()
       / Span(start, end) of scenario
      .gauge.messages.Span span = 13;
      Returns:
      Whether the span field is set.

    • getSpan

      Spec.Span getSpan()
       / Span(start, end) of scenario
      .gauge.messages.Span span = 13;
      Returns:
      The span.

    • getSpanOrBuilder

      Spec.SpanOrBuilder getSpanOrBuilder()
       / Span(start, end) of scenario
      .gauge.messages.Span span = 13;

    • getExecutionStatusValue

      int getExecutionStatusValue()
       / Execution status for the scenario
      .gauge.messages.ExecutionStatus executionStatus = 14;
      Returns:
      The enum numeric value on the wire for executionStatus.

    • getExecutionStatus

      Spec.ExecutionStatus getExecutionStatus()
       / Execution status for the scenario
      .gauge.messages.ExecutionStatus executionStatus = 14;
      Returns:
      The executionStatus.

    • getPreHookMessagesList

      List<String> getPreHookMessagesList()
       / Additional information at pre hook exec time to be available on reports
      repeated string preHookMessages = 15;
      Returns:
      A list containing the preHookMessages.

    • getPreHookMessagesCount

      int getPreHookMessagesCount()
       / Additional information at pre hook exec time to be available on reports
      repeated string preHookMessages = 15;
      Returns:
      The count of preHookMessages.

    • getPreHookMessages

      String getPreHookMessages(int index)
       / Additional information at pre hook exec time to be available on reports
      repeated string preHookMessages = 15;
      Parameters:
      index - The index of the element to return.
      Returns:
      The preHookMessages at the given index.

    • getPreHookMessagesBytes

      com.google.protobuf.ByteString getPreHookMessagesBytes(int index)
       / Additional information at pre hook exec time to be available on reports
      repeated string preHookMessages = 15;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the preHookMessages at the given index.

    • getPostHookMessagesList

      List<String> getPostHookMessagesList()
       / Additional information at post hook exec time to be available on reports
      repeated string postHookMessages = 16;
      Returns:
      A list containing the postHookMessages.

    • getPostHookMessagesCount

      int getPostHookMessagesCount()
       / Additional information at post hook exec time to be available on reports
      repeated string postHookMessages = 16;
      Returns:
      The count of postHookMessages.

    • getPostHookMessages

      String getPostHookMessages(int index)
       / Additional information at post hook exec time to be available on reports
      repeated string postHookMessages = 16;
      Parameters:
      index - The index of the element to return.
      Returns:
      The postHookMessages at the given index.

    • getPostHookMessagesBytes

      com.google.protobuf.ByteString getPostHookMessagesBytes(int index)
       / Additional information at post hook exec time to be available on reports
      repeated string postHookMessages = 16;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the postHookMessages at the given index.

    • getPreHookMessageList

      @Deprecated List<String> getPreHookMessageList()
      Deprecated.
      gauge.messages.ProtoScenario.preHookMessage is deprecated. See spec.proto;l=129
       / [DEPRECATED, use preHookMessages] Additional information at pre hook exec time to be available on reports
      repeated string preHookMessage = 17 [deprecated = true];
      Returns:
      A list containing the preHookMessage.

    • getPreHookMessageCount

      @Deprecated int getPreHookMessageCount()
      Deprecated.
      gauge.messages.ProtoScenario.preHookMessage is deprecated. See spec.proto;l=129
       / [DEPRECATED, use preHookMessages] Additional information at pre hook exec time to be available on reports
      repeated string preHookMessage = 17 [deprecated = true];
      Returns:
      The count of preHookMessage.

    • getPreHookMessage

      @Deprecated String getPreHookMessage(int index)
      Deprecated.
      gauge.messages.ProtoScenario.preHookMessage is deprecated. See spec.proto;l=129
       / [DEPRECATED, use preHookMessages] Additional information at pre hook exec time to be available on reports
      repeated string preHookMessage = 17 [deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The preHookMessage at the given index.

    • getPreHookMessageBytes

      @Deprecated com.google.protobuf.ByteString getPreHookMessageBytes(int index)
      Deprecated.
      gauge.messages.ProtoScenario.preHookMessage is deprecated. See spec.proto;l=129
       / [DEPRECATED, use preHookMessages] Additional information at pre hook exec time to be available on reports
      repeated string preHookMessage = 17 [deprecated = true];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the preHookMessage at the given index.

    • getPostHookMessageList

      @Deprecated List<String> getPostHookMessageList()
      Deprecated.
      gauge.messages.ProtoScenario.postHookMessage is deprecated. See spec.proto;l=131
       / [DEPRECATED, use postHookMessages] Additional information at post hook exec time to be available on reports
      repeated string postHookMessage = 18 [deprecated = true];
      Returns:
      A list containing the postHookMessage.

    • getPostHookMessageCount

      @Deprecated int getPostHookMessageCount()
      Deprecated.
      gauge.messages.ProtoScenario.postHookMessage is deprecated. See spec.proto;l=131
       / [DEPRECATED, use postHookMessages] Additional information at post hook exec time to be available on reports
      repeated string postHookMessage = 18 [deprecated = true];
      Returns:
      The count of postHookMessage.

    • getPostHookMessage

      @Deprecated String getPostHookMessage(int index)
      Deprecated.
      gauge.messages.ProtoScenario.postHookMessage is deprecated. See spec.proto;l=131
       / [DEPRECATED, use postHookMessages] Additional information at post hook exec time to be available on reports
      repeated string postHookMessage = 18 [deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The postHookMessage at the given index.

    • getPostHookMessageBytes

      @Deprecated com.google.protobuf.ByteString getPostHookMessageBytes(int index)
      Deprecated.
      gauge.messages.ProtoScenario.postHookMessage is deprecated. See spec.proto;l=131
       / [DEPRECATED, use postHookMessages] Additional information at post hook exec time to be available on reports
      repeated string postHookMessage = 18 [deprecated = true];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the postHookMessage at the given index.

    • getPreHookScreenshotsList

      @Deprecated List<com.google.protobuf.ByteString> getPreHookScreenshotsList()
      Deprecated.
      gauge.messages.ProtoScenario.preHookScreenshots is deprecated. See spec.proto;l=133
       / [DEPRECATED, use preHookScreenshotFiles] Capture Screenshot at pre hook exec time to be available on reports
      repeated bytes preHookScreenshots = 19 [deprecated = true];
      Returns:
      A list containing the preHookScreenshots.

    • getPreHookScreenshotsCount

      @Deprecated int getPreHookScreenshotsCount()
      Deprecated.
      gauge.messages.ProtoScenario.preHookScreenshots is deprecated. See spec.proto;l=133
       / [DEPRECATED, use preHookScreenshotFiles] Capture Screenshot at pre hook exec time to be available on reports
      repeated bytes preHookScreenshots = 19 [deprecated = true];
      Returns:
      The count of preHookScreenshots.

    • getPreHookScreenshots

      @Deprecated com.google.protobuf.ByteString getPreHookScreenshots(int index)
      Deprecated.
      gauge.messages.ProtoScenario.preHookScreenshots is deprecated. See spec.proto;l=133
       / [DEPRECATED, use preHookScreenshotFiles] Capture Screenshot at pre hook exec time to be available on reports
      repeated bytes preHookScreenshots = 19 [deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The preHookScreenshots at the given index.

    • getPostHookScreenshotsList

      @Deprecated List<com.google.protobuf.ByteString> getPostHookScreenshotsList()
      Deprecated.
      gauge.messages.ProtoScenario.postHookScreenshots is deprecated. See spec.proto;l=135
       / [DEPRECATED, use postHookScreenshotFiles] Capture Screenshot at post hook exec time to be available on reports
      repeated bytes postHookScreenshots = 20 [deprecated = true];
      Returns:
      A list containing the postHookScreenshots.

    • getPostHookScreenshotsCount

      @Deprecated int getPostHookScreenshotsCount()
      Deprecated.
      gauge.messages.ProtoScenario.postHookScreenshots is deprecated. See spec.proto;l=135
       / [DEPRECATED, use postHookScreenshotFiles] Capture Screenshot at post hook exec time to be available on reports
      repeated bytes postHookScreenshots = 20 [deprecated = true];
      Returns:
      The count of postHookScreenshots.

    • getPostHookScreenshots

      @Deprecated com.google.protobuf.ByteString getPostHookScreenshots(int index)
      Deprecated.
      gauge.messages.ProtoScenario.postHookScreenshots is deprecated. See spec.proto;l=135
       / [DEPRECATED, use postHookScreenshotFiles] Capture Screenshot at post hook exec time to be available on reports
      repeated bytes postHookScreenshots = 20 [deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The postHookScreenshots at the given index.

    • getPreHookScreenshotFilesList

      List<String> getPreHookScreenshotFilesList()
       / Screenshots captured on pre hook exec time to be available on reports
      repeated string preHookScreenshotFiles = 21;
      Returns:
      A list containing the preHookScreenshotFiles.

    • getPreHookScreenshotFilesCount

      int getPreHookScreenshotFilesCount()
       / Screenshots captured on pre hook exec time to be available on reports
      repeated string preHookScreenshotFiles = 21;
      Returns:
      The count of preHookScreenshotFiles.

    • getPreHookScreenshotFiles

      String getPreHookScreenshotFiles(int index)
       / Screenshots captured on pre hook exec time to be available on reports
      repeated string preHookScreenshotFiles = 21;
      Parameters:
      index - The index of the element to return.
      Returns:
      The preHookScreenshotFiles at the given index.

    • getPreHookScreenshotFilesBytes

      com.google.protobuf.ByteString getPreHookScreenshotFilesBytes(int index)
       / Screenshots captured on pre hook exec time to be available on reports
      repeated string preHookScreenshotFiles = 21;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the preHookScreenshotFiles at the given index.

    • getPostHookScreenshotFilesList

      List<String> getPostHookScreenshotFilesList()
       / Screenshots captured on post hook exec time to be available on reports
      repeated string postHookScreenshotFiles = 22;
      Returns:
      A list containing the postHookScreenshotFiles.

    • getPostHookScreenshotFilesCount

      int getPostHookScreenshotFilesCount()
       / Screenshots captured on post hook exec time to be available on reports
      repeated string postHookScreenshotFiles = 22;
      Returns:
      The count of postHookScreenshotFiles.

    • getPostHookScreenshotFiles

      String getPostHookScreenshotFiles(int index)
       / Screenshots captured on post hook exec time to be available on reports
      repeated string postHookScreenshotFiles = 22;
      Parameters:
      index - The index of the element to return.
      Returns:
      The postHookScreenshotFiles at the given index.

    • getPostHookScreenshotFilesBytes

      com.google.protobuf.ByteString getPostHookScreenshotFilesBytes(int index)
       / Screenshots captured on post hook exec time to be available on reports
      repeated string postHookScreenshotFiles = 22;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the postHookScreenshotFiles at the given index.

    • getRetriesCount

      long getRetriesCount()
       / Number of retires
      int64 retriesCount = 23;
      Returns:
      The retriesCount.