Class History

  • All Implemented Interfaces:
    Serializable, Cloneable

    public class History
    extends Object
    implements Serializable, Cloneable

    Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.

    See Also:
    Serialized Form
    • Constructor Detail

      • History

        public History()
    • Method Detail

      • getEvents

        public List<HistoryEvent> getEvents()

        The list of history events.

        Returns:
        The list of history events.
      • setEvents

        public void setEvents​(Collection<HistoryEvent> events)

        The list of history events.

        Parameters:
        events - The list of history events.
      • withEvents

        public History withEvents​(HistoryEvent... events)

        The list of history events.

        NOTE: This method appends the values to the existing list (if any). Use setEvents(java.util.Collection) or withEvents(java.util.Collection) if you want to override the existing values.

        Parameters:
        events - The list of history events.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withEvents

        public History withEvents​(Collection<HistoryEvent> events)

        The list of history events.

        Parameters:
        events - The list of history events.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setNextPageToken

        public void setNextPageToken​(String nextPageToken)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

        Parameters:
        nextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

      • getNextPageToken

        public String getNextPageToken()

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

        Returns:
        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

      • withNextPageToken

        public History withNextPageToken​(String nextPageToken)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

        Parameters:
        nextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object