Package org.opensearch.test.rest.yaml.section

Class SkipSection

java.lang.Object
org.opensearch.test.rest.yaml.section.SkipSection
public class SkipSection
extends java.lang.Object
Represents a skip section that tells whether a specific test section or suite needs to be skipped based on: - the opensearch version the tests are running against - a specific test feature required that might not be implemented yet by the runner

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static SkipSection EMPTY  

  • Constructor Summary

    Constructors 
    Constructor Description
    SkipSection​(java.lang.String versionRange, java.util.List<java.lang.String> features, java.lang.String reason)  

  • Method Summary

    Modifier and Type Method Description
    java.util.List<java.lang.String> getFeatures()  
    org.opensearch.Version getLowerVersion()  
    java.lang.String getReason()  
    java.lang.String getSkipMessage​(java.lang.String description)  
    org.opensearch.Version getUpperVersion()  
    boolean isEmpty()  
    boolean isVersionCheck()  
    static SkipSection parse​(org.opensearch.common.xcontent.XContentParser parser)  
    static SkipSection parseIfNext​(org.opensearch.common.xcontent.XContentParser parser)
    Parse a SkipSection if the next field is skip, otherwise returns EMPTY.
    boolean skip​(org.opensearch.Version currentVersion)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • SkipSection

      public SkipSection​(java.lang.String versionRange, java.util.List<java.lang.String> features, java.lang.String reason)

  • Method Details

    • parseIfNext

      public static SkipSection parseIfNext​(org.opensearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Parse a SkipSection if the next field is skip, otherwise returns EMPTY.
      Throws:
      java.io.IOException

    • parse

      public static SkipSection parse​(org.opensearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • getLowerVersion

      public org.opensearch.Version getLowerVersion()

    • getUpperVersion

      public org.opensearch.Version getUpperVersion()

    • getFeatures

      public java.util.List<java.lang.String> getFeatures()

    • getReason

      public java.lang.String getReason()

    • skip

      public boolean skip​(org.opensearch.Version currentVersion)

    • isVersionCheck

      public boolean isVersionCheck()

    • isEmpty

      public boolean isEmpty()

    • getSkipMessage

      public java.lang.String getSkipMessage​(java.lang.String description)