Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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;
 
 
Container for the parameters to the GetWorkflowExecutionHistory operation.

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

 
 public class GetWorkflowExecutionHistoryRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

 
     private String domain;

    
Specifies the workflow execution for which to return the history.
 
     private WorkflowExecution execution;

    
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.

Constraints:
Length: 0 - 2048

 
     private String nextPageToken;

    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Constraints:
Range: 0 - 1000

    private Integer maximumPageSize;

    
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
    private Boolean reverseOrder;

    
The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

Returns:
The name of the domain containing the workflow execution.
    public String getDomain() {
        return ;
    }
    
    
The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

Parameters:
domain The name of the domain containing the workflow execution.
    public void setDomain(String domain) {
        this. = domain;
    }
    
    
The name of the domain containing the workflow execution.

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

Constraints:
Length: 1 - 256

Parameters:
domain The name of the domain containing the workflow execution.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = domain;
        return this;
    }

    
Specifies the workflow execution for which to return the history.

Returns:
Specifies the workflow execution for which to return the history.
    public WorkflowExecution getExecution() {
        return ;
    }
    
    
Specifies the workflow execution for which to return the history.

Parameters:
execution Specifies the workflow execution for which to return the history.
    public void setExecution(WorkflowExecution execution) {
        this. = execution;
    }
    
    
Specifies the workflow execution for which to return the history.

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

Parameters:
execution Specifies the workflow execution for which to return the history.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = execution;
        return this;
    }

    
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.

Constraints:
Length: 0 - 2048

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.

    public String getNextPageToken() {
        return ;
    }
    
    
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.

Constraints:
Length: 0 - 2048

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.

    public void setNextPageToken(String nextPageToken) {
        this. = 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 2048

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:
A reference to this updated object so that method calls can be chained together.
        this. = nextPageToken;
        return this;
    }

    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Constraints:
Range: 0 - 1000

Returns:
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

    public Integer getMaximumPageSize() {
        return ;
    }
    
    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Constraints:
Range: 0 - 1000

Parameters:
maximumPageSize The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

    public void setMaximumPageSize(Integer maximumPageSize) {
        this. = maximumPageSize;
    }
    
    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

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

Constraints:
Range: 0 - 1000

Parameters:
maximumPageSize The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Returns:
A reference to this updated object so that method calls can be chained together.
        this. = maximumPageSize;
        return this;
    }

    
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Returns:
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
    public Boolean isReverseOrder() {
        return ;
    }
    
    
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Parameters:
reverseOrder When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
    public void setReverseOrder(Boolean reverseOrder) {
        this. = reverseOrder;
    }
    
    
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

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

Parameters:
reverseOrder When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = reverseOrder;
        return this;
    }

    
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Returns:
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
    public Boolean getReverseOrder() {
        return ;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getDomain() != nullsb.append("Domain: " + getDomain() + ",");
        if (getExecution() != nullsb.append("Execution: " + getExecution() + ",");
        if (getNextPageToken() != nullsb.append("NextPageToken: " + getNextPageToken() + ",");
        if (getMaximumPageSize() != nullsb.append("MaximumPageSize: " + getMaximumPageSize() + ",");
        if (isReverseOrder() != nullsb.append("ReverseOrder: " + isReverseOrder() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode()); 
        hashCode = prime * hashCode + ((getExecution() == null) ? 0 : getExecution().hashCode()); 
        hashCode = prime * hashCode + ((getNextPageToken() == null) ? 0 : getNextPageToken().hashCode()); 
        hashCode = prime * hashCode + ((getMaximumPageSize() == null) ? 0 : getMaximumPageSize().hashCode()); 
        hashCode = prime * hashCode + ((isReverseOrder() == null) ? 0 : isReverseOrder().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof GetWorkflowExecutionHistoryRequest == falsereturn false;
        
        if (other.getDomain() == null ^ this.getDomain() == nullreturn false;
        if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == falsereturn false
        if (other.getExecution() == null ^ this.getExecution() == nullreturn false;
        if (other.getExecution() != null && other.getExecution().equals(this.getExecution()) == falsereturn false
        if (other.getNextPageToken() == null ^ this.getNextPageToken() == nullreturn false;
        if (other.getNextPageToken() != null && other.getNextPageToken().equals(this.getNextPageToken()) == falsereturn false
        if (other.getMaximumPageSize() == null ^ this.getMaximumPageSize() == nullreturn false;
        if (other.getMaximumPageSize() != null && other.getMaximumPageSize().equals(this.getMaximumPageSize()) == falsereturn false
        if (other.isReverseOrder() == null ^ this.isReverseOrder() == nullreturn false;
        if (other.isReverseOrder() != null && other.isReverseOrder().equals(this.isReverseOrder()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (GetWorkflowExecutionHistoryRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X