/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.simpleworkflow.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
* <p>
* 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.
* </p>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class History extends com.amazonaws.AmazonWebServiceResult<com.amazonaws.ResponseMetadata> implements Serializable, Cloneable {
/**
* <p>
* The list of history events.
* </p>
*/
private java.util.List<HistoryEvent> events;
/**
* <p>
* If a <code>NextPageToken</code> 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 <code>nextPageToken</code>. Keep all
* other arguments unchanged.
* </p>
* <p>
* The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.
* </p>
*/
private String nextPageToken;
/**
* <p>
* The list of history events.
* </p>
*
* @return The list of history events.
*/
public java.util.List<HistoryEvent> getEvents() {
return events;
}
/**
* <p>
* The list of history events.
* </p>
*
* @param events
* The list of history events.
*/
public void setEvents(java.util.Collection<HistoryEvent> events) {
if (events == null) {
this.events = null;
return;
}
this.events = new java.util.ArrayList<HistoryEvent>(events);
}
/**
* <p>
* The list of history events.
* </p>
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setEvents(java.util.Collection)} or {@link #withEvents(java.util.Collection)} if you want to override the
* existing values.
* </p>
*
* @param events
* The list of history events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public History withEvents(HistoryEvent... events) {
if (this.events == null) {
setEvents(new java.util.ArrayList<HistoryEvent>(events.length));
}
for (HistoryEvent ele : events) {
this.events.add(ele);
}
return this;
}
/**
* <p>
* The list of history events.
* </p>
*
* @param events
* The list of history events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public History withEvents(java.util.Collection<HistoryEvent> events) {
setEvents(events);
return this;
}
/**
* <p>
* If a <code>NextPageToken</code> 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 <code>nextPageToken</code>. Keep all
* other arguments unchanged.
* </p>
* <p>
* The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.
* </p>
*
* @param nextPageToken
* If a <code>NextPageToken</code> 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
* <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
* <p>
* The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.
*/
public void setNextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
}
/**
* <p>
* If a <code>NextPageToken</code> 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 <code>nextPageToken</code>. Keep all
* other arguments unchanged.
* </p>
* <p>
* The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.
* </p>
*
* @return If a <code>NextPageToken</code> 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
* <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
* <p>
* The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.
*/
public String getNextPageToken() {
return this.nextPageToken;
}
/**
* <p>
* If a <code>NextPageToken</code> 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 <code>nextPageToken</code>. Keep all
* other arguments unchanged.
* </p>
* <p>
* The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.
* </p>
*
* @param nextPageToken
* If a <code>NextPageToken</code> 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
* <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
* <p>
* The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public History withNextPageToken(String nextPageToken) {
setNextPageToken(nextPageToken);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEvents() != null)
sb.append("Events: ").append(getEvents()).append(",");
if (getNextPageToken() != null)
sb.append("NextPageToken: ").append(getNextPageToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof History == false)
return false;
History other = (History) obj;
if (other.getEvents() == null ^ this.getEvents() == null)
return false;
if (other.getEvents() != null && other.getEvents().equals(this.getEvents()) == false)
return false;
if (other.getNextPageToken() == null ^ this.getNextPageToken() == null)
return false;
if (other.getNextPageToken() != null && other.getNextPageToken().equals(this.getNextPageToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEvents() == null) ? 0 : getEvents().hashCode());
hashCode = prime * hashCode + ((getNextPageToken() == null) ? 0 : getNextPageToken().hashCode());
return hashCode;
}
@Override
public History clone() {
try {
return (History) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}