com.amazonaws.services.simpleworkflow.model

## クラス GetWorkflowExecutionHistoryRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.simpleworkflow.model.GetWorkflowExecutionHistoryRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class GetWorkflowExecutionHistoryRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  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 by throwing `OperationNotPermitted` . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

  関連項目:
    `AmazonSimpleWorkflow.getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `GetWorkflowExecutionHistoryRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getDomain()` The name of the domain containing the workflow execution.
    `WorkflowExecution` | `getExecution()` Specifies the workflow execution for which to return the history.
    `java.lang.Integer` | `getMaximumPageSize()` Specifies the maximum number of history events returned in one page.
    `java.lang.String` | `getNextPageToken()` If a `NextPageToken` is returned, the result has more than one pages.
    `java.lang.Boolean` | `getReverseOrder()` When set to `true`, returns the events in reverse order.
    `int` | `hashCode()`
    `java.lang.Boolean` | `isReverseOrder()` When set to `true`, returns the events in reverse order.
    `void` | `setDomain(java.lang.String domain)` The name of the domain containing the workflow execution.
    `void` | `setExecution(WorkflowExecution execution)` Specifies the workflow execution for which to return the history.
    `void` | `setMaximumPageSize(java.lang.Integer maximumPageSize)` Specifies the maximum number of history events returned in one page.
    `void` | `setNextPageToken(java.lang.String nextPageToken)` If a `NextPageToken` is returned, the result has more than one pages.
    `void` | `setReverseOrder(java.lang.Boolean reverseOrder)` When set to `true`, returns the events in reverse order.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `GetWorkflowExecutionHistoryRequest` | `withDomain(java.lang.String domain)` The name of the domain containing the workflow execution.
    `GetWorkflowExecutionHistoryRequest` | `withExecution(WorkflowExecution execution)` Specifies the workflow execution for which to return the history.
    `GetWorkflowExecutionHistoryRequest` | `withMaximumPageSize(java.lang.Integer maximumPageSize)` Specifies the maximum number of history events returned in one page.
    `GetWorkflowExecutionHistoryRequest` | `withNextPageToken(java.lang.String nextPageToken)` If a `NextPageToken` is returned, the result has more than one pages.
    `GetWorkflowExecutionHistoryRequest` | `withReverseOrder(java.lang.Boolean reverseOrder)` When set to `true`, returns the events in reverse order.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### GetWorkflowExecutionHistoryRequest

          public GetWorkflowExecutionHistoryRequest()

  - ### メソッドの詳細

    - #### getDomain

          public java.lang.String getDomain()

      The name of the domain containing the workflow execution.

      Constraints:
      Length: 1 - 256

      戻り値:
        The name of the domain containing the workflow execution.

    - #### setDomain

          public void setDomain(java.lang.String domain)

      The name of the domain containing the workflow execution.

      Constraints:
      Length: 1 - 256

      パラメータ:
        `domain` - The name of the domain containing the workflow execution.

    - #### withDomain

          public GetWorkflowExecutionHistoryRequest withDomain(java.lang.String 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

      パラメータ:
        `domain` - The name of the domain containing the workflow execution.

    - #### getExecution

          public WorkflowExecution getExecution()

      Specifies the workflow execution for which to return the history.
      戻り値:
        Specifies the workflow execution for which to return the history.

    - #### setExecution

          public void setExecution(WorkflowExecution execution)

      Specifies the workflow execution for which to return the history.
      パラメータ:
        `execution` - Specifies the workflow execution for which to return the history.

    - #### withExecution

          public GetWorkflowExecutionHistoryRequest withExecution(WorkflowExecution 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.

      パラメータ:
        `execution` - Specifies the workflow execution for which to return the history.

    - #### getNextPageToken

          public java.lang.String getNextPageToken()

      If a `NextPageToken` is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

      Constraints:
      Length: 0 - 2048

      戻り値:
        If a `NextPageToken` is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

    - #### setNextPageToken

          public void setNextPageToken(java.lang.String nextPageToken)

      If a `NextPageToken` is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

      Constraints:
      Length: 0 - 2048

      パラメータ:
        `nextPageToken` - If a `NextPageToken` is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

    - #### withNextPageToken

          public GetWorkflowExecutionHistoryRequest withNextPageToken(java.lang.String nextPageToken)

      If a `NextPageToken` is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

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

      Constraints:
      Length: 0 - 2048

      パラメータ:
        `nextPageToken` - If a `NextPageToken` is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

    - #### getMaximumPageSize

          public java.lang.Integer getMaximumPageSize()

      Specifies the maximum number of history events returned in one page. The next page in the result is identified by the `NextPageToken` returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

      Constraints:
      Range: 0 - 1000

      戻り値:
        Specifies the maximum number of history events returned in one page. The next page in the result is identified by the `NextPageToken` returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

    - #### setMaximumPageSize

          public void setMaximumPageSize(java.lang.Integer maximumPageSize)

      Specifies the maximum number of history events returned in one page. The next page in the result is identified by the `NextPageToken` returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

      Constraints:
      Range: 0 - 1000

      パラメータ:
        `maximumPageSize` - Specifies the maximum number of history events returned in one page. The next page in the result is identified by the `NextPageToken` returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

    - #### withMaximumPageSize

          public GetWorkflowExecutionHistoryRequest withMaximumPageSize(java.lang.Integer maximumPageSize)

      Specifies the maximum number of history events returned in one page. The next page in the result is identified by the `NextPageToken` returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

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

      Constraints:
      Range: 0 - 1000

      パラメータ:
        `maximumPageSize` - Specifies the maximum number of history events returned in one page. The next page in the result is identified by the `NextPageToken` returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

    - #### isReverseOrder

          public java.lang.Boolean isReverseOrder()

      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.
      戻り値:
        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.

    - #### setReverseOrder

          public void setReverseOrder(java.lang.Boolean 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.
      パラメータ:
        `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.

    - #### withReverseOrder

          public GetWorkflowExecutionHistoryRequest withReverseOrder(java.lang.Boolean 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.

      パラメータ:
        `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.

    - #### getReverseOrder

          public java.lang.Boolean getReverseOrder()

      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.
      戻り値:
        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.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`