Package gauge.messages

Class Spec.ProtoScenario

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Spec.ProtoScenarioOrBuilder, Serializable
    Enclosing class:
    Spec
    public static final class Spec.ProtoScenario
extends com.google.protobuf.GeneratedMessageV3
implements Spec.ProtoScenarioOrBuilder
    / A proto object representing a Scenario
    Protobuf type gauge.messages.ProtoScenario
    See Also:
    Serialized Form

    • Field Detail

      • SCENARIOHEADING_FIELD_NUMBER

        public static final int SCENARIOHEADING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCENARIOITEMS_FIELD_NUMBER

        public static final int SCENARIOITEMS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREHOOKFAILURE_FIELD_NUMBER

        public static final int PREHOOKFAILURE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POSTHOOKFAILURE_FIELD_NUMBER

        public static final int POSTHOOKFAILURE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXECUTIONTIME_FIELD_NUMBER

        public static final int EXECUTIONTIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SKIPERRORS_FIELD_NUMBER

        public static final int SKIPERRORS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEARDOWNSTEPS_FIELD_NUMBER

        public static final int TEARDOWNSTEPS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXECUTIONSTATUS_FIELD_NUMBER

        public static final int EXECUTIONSTATUS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREHOOKMESSAGES_FIELD_NUMBER

        public static final int PREHOOKMESSAGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POSTHOOKMESSAGES_FIELD_NUMBER

        public static final int POSTHOOKMESSAGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREHOOKMESSAGE_FIELD_NUMBER

        public static final int PREHOOKMESSAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POSTHOOKMESSAGE_FIELD_NUMBER

        public static final int POSTHOOKMESSAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREHOOKSCREENSHOTS_FIELD_NUMBER

        public static final int PREHOOKSCREENSHOTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POSTHOOKSCREENSHOTS_FIELD_NUMBER

        public static final int POSTHOOKSCREENSHOTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREHOOKSCREENSHOTFILES_FIELD_NUMBER

        public static final int PREHOOKSCREENSHOTFILES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POSTHOOKSCREENSHOTFILES_FIELD_NUMBER

        public static final int POSTHOOKSCREENSHOTFILES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getContextsCount

        public int getContextsCount()
        / Collection of Context steps. The Context steps are executed before every run.
        repeated .gauge.messages.ProtoItem contexts = 3;
        Specified by:
        getContextsCount in interface Spec.ProtoScenarioOrBuilder

      • getContexts

        public Spec.ProtoItem getContexts​(int index)
        / Collection of Context steps. The Context steps are executed before every run.
        repeated .gauge.messages.ProtoItem contexts = 3;
        Specified by:
        getContexts in interface Spec.ProtoScenarioOrBuilder

      • getScenarioItemsCount

        public int getScenarioItemsCount()
        / Collection of Items under a scenario. These could be Steps, Comments, Tags, TableDrivenScenarios or Tables
        repeated .gauge.messages.ProtoItem scenarioItems = 4;
        Specified by:
        getScenarioItemsCount in interface Spec.ProtoScenarioOrBuilder

      • getScenarioItems

        public 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;
        Specified by:
        getScenarioItems in interface Spec.ProtoScenarioOrBuilder

      • hasPreHookFailure

        public boolean hasPreHookFailure()
        / Contains a 'before' hook failure message. This happens when the `before_scenario` hook has an error.
        .gauge.messages.ProtoHookFailure preHookFailure = 5;
        Specified by:
        hasPreHookFailure in interface Spec.ProtoScenarioOrBuilder

      • hasPostHookFailure

        public boolean hasPostHookFailure()
        / Contains a 'after' hook failure message. This happens when the `after_scenario` hook has an error.
        .gauge.messages.ProtoHookFailure postHookFailure = 6;
        Specified by:
        hasPostHookFailure in interface Spec.ProtoScenarioOrBuilder

      • getTagsList

        public com.google.protobuf.ProtocolStringList getTagsList()
        / Contains a list of tags that are defined at the specification level. Scenario tags are not present here.
        repeated string tags = 7;
        Specified by:
        getTagsList in interface Spec.ProtoScenarioOrBuilder

      • getTagsCount

        public int getTagsCount()
        / Contains a list of tags that are defined at the specification level. Scenario tags are not present here.
        repeated string tags = 7;
        Specified by:
        getTagsCount in interface Spec.ProtoScenarioOrBuilder

      • getTags

        public 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;
        Specified by:
        getTags in interface Spec.ProtoScenarioOrBuilder

      • getTagsBytes

        public 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;
        Specified by:
        getTagsBytes in interface Spec.ProtoScenarioOrBuilder

      • getSkipErrorsList

        public com.google.protobuf.ProtocolStringList getSkipErrorsList()
        / Holds the error messages for skipping scenario from execution
        repeated string skipErrors = 10;
        Specified by:
        getSkipErrorsList in interface Spec.ProtoScenarioOrBuilder

      • getSkipErrorsCount

        public int getSkipErrorsCount()
        / Holds the error messages for skipping scenario from execution
        repeated string skipErrors = 10;
        Specified by:
        getSkipErrorsCount in interface Spec.ProtoScenarioOrBuilder

      • getSkipErrorsBytes

        public com.google.protobuf.ByteString getSkipErrorsBytes​(int index)
        / Holds the error messages for skipping scenario from execution
        repeated string skipErrors = 10;
        Specified by:
        getSkipErrorsBytes in interface Spec.ProtoScenarioOrBuilder

      • getIDBytes

        public com.google.protobuf.ByteString getIDBytes()
        / Holds the unique Identifier of a scenario.
        string ID = 11;
        Specified by:
        getIDBytes in interface Spec.ProtoScenarioOrBuilder

      • getTearDownStepsCount

        public int getTearDownStepsCount()
        / Collection of Teardown steps. The Teardown steps are executed after every run.
        repeated .gauge.messages.ProtoItem tearDownSteps = 12;
        Specified by:
        getTearDownStepsCount in interface Spec.ProtoScenarioOrBuilder

      • getPreHookMessagesList

        public com.google.protobuf.ProtocolStringList getPreHookMessagesList()
        / Additional information at pre hook exec time to be available on reports
        repeated string preHookMessages = 15;
        Specified by:
        getPreHookMessagesList in interface Spec.ProtoScenarioOrBuilder

      • getPreHookMessagesCount

        public int getPreHookMessagesCount()
        / Additional information at pre hook exec time to be available on reports
        repeated string preHookMessages = 15;
        Specified by:
        getPreHookMessagesCount in interface Spec.ProtoScenarioOrBuilder

      • getPreHookMessages

        public String getPreHookMessages​(int index)
        / Additional information at pre hook exec time to be available on reports
        repeated string preHookMessages = 15;
        Specified by:
        getPreHookMessages in interface Spec.ProtoScenarioOrBuilder

      • getPreHookMessagesBytes

        public com.google.protobuf.ByteString getPreHookMessagesBytes​(int index)
        / Additional information at pre hook exec time to be available on reports
        repeated string preHookMessages = 15;
        Specified by:
        getPreHookMessagesBytes in interface Spec.ProtoScenarioOrBuilder

      • getPostHookMessagesList

        public com.google.protobuf.ProtocolStringList getPostHookMessagesList()
        / Additional information at post hook exec time to be available on reports
        repeated string postHookMessages = 16;
        Specified by:
        getPostHookMessagesList in interface Spec.ProtoScenarioOrBuilder

      • getPostHookMessagesCount

        public int getPostHookMessagesCount()
        / Additional information at post hook exec time to be available on reports
        repeated string postHookMessages = 16;
        Specified by:
        getPostHookMessagesCount in interface Spec.ProtoScenarioOrBuilder

      • getPostHookMessages

        public String getPostHookMessages​(int index)
        / Additional information at post hook exec time to be available on reports
        repeated string postHookMessages = 16;
        Specified by:
        getPostHookMessages in interface Spec.ProtoScenarioOrBuilder

      • getPostHookMessagesBytes

        public com.google.protobuf.ByteString getPostHookMessagesBytes​(int index)
        / Additional information at post hook exec time to be available on reports
        repeated string postHookMessages = 16;
        Specified by:
        getPostHookMessagesBytes in interface Spec.ProtoScenarioOrBuilder

      • getPreHookMessageList

        @Deprecated
public com.google.protobuf.ProtocolStringList getPreHookMessageList()
        Deprecated.
        / [DEPRECATED, use preHookMessages] Additional information at pre hook exec time to be available on reports
        repeated string preHookMessage = 17 [deprecated = true];
        Specified by:
        getPreHookMessageList in interface Spec.ProtoScenarioOrBuilder

      • getPreHookMessageCount

        @Deprecated
public int getPreHookMessageCount()
        Deprecated.
        / [DEPRECATED, use preHookMessages] Additional information at pre hook exec time to be available on reports
        repeated string preHookMessage = 17 [deprecated = true];
        Specified by:
        getPreHookMessageCount in interface Spec.ProtoScenarioOrBuilder

      • getPreHookMessage

        @Deprecated
public String getPreHookMessage​(int index)
        Deprecated.
        / [DEPRECATED, use preHookMessages] Additional information at pre hook exec time to be available on reports
        repeated string preHookMessage = 17 [deprecated = true];
        Specified by:
        getPreHookMessage in interface Spec.ProtoScenarioOrBuilder

      • getPreHookMessageBytes

        @Deprecated
public com.google.protobuf.ByteString getPreHookMessageBytes​(int index)
        Deprecated.
        / [DEPRECATED, use preHookMessages] Additional information at pre hook exec time to be available on reports
        repeated string preHookMessage = 17 [deprecated = true];
        Specified by:
        getPreHookMessageBytes in interface Spec.ProtoScenarioOrBuilder

      • getPostHookMessageList

        @Deprecated
public com.google.protobuf.ProtocolStringList getPostHookMessageList()
        Deprecated.
        / [DEPRECATED, use postHookMessages] Additional information at post hook exec time to be available on reports
        repeated string postHookMessage = 18 [deprecated = true];
        Specified by:
        getPostHookMessageList in interface Spec.ProtoScenarioOrBuilder

      • getPostHookMessageCount

        @Deprecated
public int getPostHookMessageCount()
        Deprecated.
        / [DEPRECATED, use postHookMessages] Additional information at post hook exec time to be available on reports
        repeated string postHookMessage = 18 [deprecated = true];
        Specified by:
        getPostHookMessageCount in interface Spec.ProtoScenarioOrBuilder

      • getPostHookMessage

        @Deprecated
public String getPostHookMessage​(int index)
        Deprecated.
        / [DEPRECATED, use postHookMessages] Additional information at post hook exec time to be available on reports
        repeated string postHookMessage = 18 [deprecated = true];
        Specified by:
        getPostHookMessage in interface Spec.ProtoScenarioOrBuilder

      • getPostHookMessageBytes

        @Deprecated
public com.google.protobuf.ByteString getPostHookMessageBytes​(int index)
        Deprecated.
        / [DEPRECATED, use postHookMessages] Additional information at post hook exec time to be available on reports
        repeated string postHookMessage = 18 [deprecated = true];
        Specified by:
        getPostHookMessageBytes in interface Spec.ProtoScenarioOrBuilder

      • getPreHookScreenshotsList

        @Deprecated
public List<com.google.protobuf.ByteString> getPreHookScreenshotsList()
        Deprecated.
        / [DEPRECATED, use preHookScreenshotFiles] Capture Screenshot at pre hook exec time to be available on reports
        repeated bytes preHookScreenshots = 19 [deprecated = true];
        Specified by:
        getPreHookScreenshotsList in interface Spec.ProtoScenarioOrBuilder

      • getPreHookScreenshotsCount

        @Deprecated
public int getPreHookScreenshotsCount()
        Deprecated.
        / [DEPRECATED, use preHookScreenshotFiles] Capture Screenshot at pre hook exec time to be available on reports
        repeated bytes preHookScreenshots = 19 [deprecated = true];
        Specified by:
        getPreHookScreenshotsCount in interface Spec.ProtoScenarioOrBuilder

      • getPreHookScreenshots

        @Deprecated
public com.google.protobuf.ByteString getPreHookScreenshots​(int index)
        Deprecated.
        / [DEPRECATED, use preHookScreenshotFiles] Capture Screenshot at pre hook exec time to be available on reports
        repeated bytes preHookScreenshots = 19 [deprecated = true];
        Specified by:
        getPreHookScreenshots in interface Spec.ProtoScenarioOrBuilder

      • getPostHookScreenshotsList

        @Deprecated
public List<com.google.protobuf.ByteString> getPostHookScreenshotsList()
        Deprecated.
        / [DEPRECATED, use postHookScreenshotFiles] Capture Screenshot at post hook exec time to be available on reports
        repeated bytes postHookScreenshots = 20 [deprecated = true];
        Specified by:
        getPostHookScreenshotsList in interface Spec.ProtoScenarioOrBuilder

      • getPostHookScreenshotsCount

        @Deprecated
public int getPostHookScreenshotsCount()
        Deprecated.
        / [DEPRECATED, use postHookScreenshotFiles] Capture Screenshot at post hook exec time to be available on reports
        repeated bytes postHookScreenshots = 20 [deprecated = true];
        Specified by:
        getPostHookScreenshotsCount in interface Spec.ProtoScenarioOrBuilder

      • getPostHookScreenshots

        @Deprecated
public com.google.protobuf.ByteString getPostHookScreenshots​(int index)
        Deprecated.
        / [DEPRECATED, use postHookScreenshotFiles] Capture Screenshot at post hook exec time to be available on reports
        repeated bytes postHookScreenshots = 20 [deprecated = true];
        Specified by:
        getPostHookScreenshots in interface Spec.ProtoScenarioOrBuilder

      • getPreHookScreenshotFilesList

        public com.google.protobuf.ProtocolStringList getPreHookScreenshotFilesList()
        / Screenshots captured on pre hook exec time to be available on reports
        repeated string preHookScreenshotFiles = 21;
        Specified by:
        getPreHookScreenshotFilesList in interface Spec.ProtoScenarioOrBuilder

      • getPreHookScreenshotFilesBytes

        public com.google.protobuf.ByteString getPreHookScreenshotFilesBytes​(int index)
        / Screenshots captured on pre hook exec time to be available on reports
        repeated string preHookScreenshotFiles = 21;
        Specified by:
        getPreHookScreenshotFilesBytes in interface Spec.ProtoScenarioOrBuilder

      • getPostHookScreenshotFilesList

        public com.google.protobuf.ProtocolStringList getPostHookScreenshotFilesList()
        / Screenshots captured on post hook exec time to be available on reports
        repeated string postHookScreenshotFiles = 22;
        Specified by:
        getPostHookScreenshotFilesList in interface Spec.ProtoScenarioOrBuilder

      • getPostHookScreenshotFilesBytes

        public com.google.protobuf.ByteString getPostHookScreenshotFilesBytes​(int index)
        / Screenshots captured on post hook exec time to be available on reports
        repeated string postHookScreenshotFiles = 22;
        Specified by:
        getPostHookScreenshotFilesBytes in interface Spec.ProtoScenarioOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Spec.ProtoScenario parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spec.ProtoScenario parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spec.ProtoScenario parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spec.ProtoScenario parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spec.ProtoScenario parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spec.ProtoScenario parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spec.ProtoScenario parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Spec.ProtoScenario.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Spec.ProtoScenario.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Spec.ProtoScenario.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Spec.ProtoScenario> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Spec.ProtoScenario getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder