Enum ConnectorExecutionStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ConnectorExecutionStatus>

    public enum ConnectorExecutionStatus
    extends java.lang.Enum<ConnectorExecutionStatus>
    implements java.io.Serializable
    An enumeration that contains the possible states a connector can be in.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COMPLETING
      The connector has finished sending and is waiting for all documents to complete.
      NOT_RUNNING
      The connector is currently not running.
      PAUSED
      The connector is running but feeding has been paused.
      RESET
      The connector was reset.
      RUNNING
      The connector is currently running.
      WAITING_TO_START
      The connector has been queued to start.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ConnectorExecutionStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ConnectorExecutionStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • WAITING_TO_START

        public static final ConnectorExecutionStatus WAITING_TO_START
        The connector has been queued to start.
      • COMPLETING

        public static final ConnectorExecutionStatus COMPLETING
        The connector has finished sending and is waiting for all documents to complete. When a connector reaches this state, the system will allow connector in the WAITING_TO_START state to start running.
      • RESET

        public static final ConnectorExecutionStatus RESET
        The connector was reset. This status has meaning only for incremental connectors. For incremental connectors, this status indicates that the incremental state for the connector was reset. The timestamp associated with the execution record will match the value given to the previous matching ingestions.
    • Method Detail

      • values

        public static ConnectorExecutionStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ConnectorExecutionStatus c : ConnectorExecutionStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ConnectorExecutionStatus valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null