com.amazonaws.services.simpleworkflow.model

## クラス ListClosedWorkflowExecutionsRequest

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

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

      public class ListClosedWorkflowExecutionsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `ListClosedWorkflowExecutions operation`.

  Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. 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.
  - Constrain the following parameters by using a `Condition` element with the appropriate keys.
    - `tag` : String constraint. The key is `swf:tagFilter.tag` .
    - `typeFilter.name` : String constraint. String constraint. The key is `swf:typeFilter.name` .
    - `typeFilter.version` : String constraint. String constraint. The key is `swf:typeFilter.version` .

  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.listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest)`, 直列化された形式

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `CloseStatusFilter` | `getCloseStatusFilter()` If specified, only workflow executions that match this close status are listed.
    `ExecutionTimeFilter` | `getCloseTimeFilter()` If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter.
    `java.lang.String` | `getDomain()` The name of the domain that contains the workflow executions to list.
    `WorkflowExecutionFilter` | `getExecutionFilter()` If specified, only workflow executions matching the workflow id specified in the filter are returned.
    `java.lang.Integer` | `getMaximumPageSize()` The maximum number of results returned in each page.
    `java.lang.String` | `getNextPageToken()` If on a previous call to this method a `NextPageToken` was returned, the results are being paginated.
    `java.lang.Boolean` | `getReverseOrder()` When set to `true`, returns the results in reverse order.
    `ExecutionTimeFilter` | `getStartTimeFilter()` If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
    `TagFilter` | `getTagFilter()` If specified, only executions that have the matching tag are listed.
    `WorkflowTypeFilter` | `getTypeFilter()` If specified, only executions of the type specified in the filter are returned.
    `int` | `hashCode()`
    `java.lang.Boolean` | `isReverseOrder()` When set to `true`, returns the results in reverse order.
    `void` | `setCloseStatusFilter(CloseStatusFilter closeStatusFilter)` If specified, only workflow executions that match this close status are listed.
    `void` | `setCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)` If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter.
    `void` | `setDomain(java.lang.String domain)` The name of the domain that contains the workflow executions to list.
    `void` | `setExecutionFilter(WorkflowExecutionFilter executionFilter)` If specified, only workflow executions matching the workflow id specified in the filter are returned.
    `void` | `setMaximumPageSize(java.lang.Integer maximumPageSize)` The maximum number of results returned in each page.
    `void` | `setNextPageToken(java.lang.String nextPageToken)` If on a previous call to this method a `NextPageToken` was returned, the results are being paginated.
    `void` | `setReverseOrder(java.lang.Boolean reverseOrder)` When set to `true`, returns the results in reverse order.
    `void` | `setStartTimeFilter(ExecutionTimeFilter startTimeFilter)` If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
    `void` | `setTagFilter(TagFilter tagFilter)` If specified, only executions that have the matching tag are listed.
    `void` | `setTypeFilter(WorkflowTypeFilter typeFilter)` If specified, only executions of the type specified in the filter are returned.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `ListClosedWorkflowExecutionsRequest` | `withCloseStatusFilter(CloseStatusFilter closeStatusFilter)` If specified, only workflow executions that match this close status are listed.
    `ListClosedWorkflowExecutionsRequest` | `withCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)` If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter.
    `ListClosedWorkflowExecutionsRequest` | `withDomain(java.lang.String domain)` The name of the domain that contains the workflow executions to list.
    `ListClosedWorkflowExecutionsRequest` | `withExecutionFilter(WorkflowExecutionFilter executionFilter)` If specified, only workflow executions matching the workflow id specified in the filter are returned.
    `ListClosedWorkflowExecutionsRequest` | `withMaximumPageSize(java.lang.Integer maximumPageSize)` The maximum number of results returned in each page.
    `ListClosedWorkflowExecutionsRequest` | `withNextPageToken(java.lang.String nextPageToken)` If on a previous call to this method a `NextPageToken` was returned, the results are being paginated.
    `ListClosedWorkflowExecutionsRequest` | `withReverseOrder(java.lang.Boolean reverseOrder)` When set to `true`, returns the results in reverse order.
    `ListClosedWorkflowExecutionsRequest` | `withStartTimeFilter(ExecutionTimeFilter startTimeFilter)` If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
    `ListClosedWorkflowExecutionsRequest` | `withTagFilter(TagFilter tagFilter)` If specified, only executions that have the matching tag are listed.
    `ListClosedWorkflowExecutionsRequest` | `withTypeFilter(WorkflowTypeFilter typeFilter)` If specified, only executions of the type specified in the filter are returned.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### ListClosedWorkflowExecutionsRequest

          public ListClosedWorkflowExecutionsRequest()

  - ### メソッドの詳細

    - #### getDomain

          public java.lang.String getDomain()

      The name of the domain that contains the workflow executions to list.

      Constraints:
      Length: 1 - 256

      戻り値:
        The name of the domain that contains the workflow executions to list.

    - #### setDomain

          public void setDomain(java.lang.String domain)

      The name of the domain that contains the workflow executions to list.

      Constraints:
      Length: 1 - 256

      パラメータ:
        `domain` - The name of the domain that contains the workflow executions to list.

    - #### withDomain

          public ListClosedWorkflowExecutionsRequest withDomain(java.lang.String domain)

      The name of the domain that contains the workflow executions to list.

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

      Constraints:
      Length: 1 - 256

      パラメータ:
        `domain` - The name of the domain that contains the workflow executions to list.

    - #### getStartTimeFilter

          public ExecutionTimeFilter getStartTimeFilter()

      If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.
      戻り値:
        If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

    - #### setStartTimeFilter

          public void setStartTimeFilter(ExecutionTimeFilter startTimeFilter)

      If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.
      パラメータ:
        `startTimeFilter` - If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

    - #### withStartTimeFilter

          public ListClosedWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter)

      If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

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

      パラメータ:
        `startTimeFilter` - If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

    - #### getCloseTimeFilter

          public ExecutionTimeFilter getCloseTimeFilter()

      If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.
      戻り値:
        If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

    - #### setCloseTimeFilter

          public void setCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)

      If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.
      パラメータ:
        `closeTimeFilter` - If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

    - #### withCloseTimeFilter

          public ListClosedWorkflowExecutionsRequest withCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)

      If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

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

      パラメータ:
        `closeTimeFilter` - If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

    - #### getExecutionFilter

          public WorkflowExecutionFilter getExecutionFilter()

      If specified, only workflow executions matching the workflow id specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
      戻り値:
        If specified, only workflow executions matching the workflow id specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### setExecutionFilter

          public void setExecutionFilter(WorkflowExecutionFilter executionFilter)

      If specified, only workflow executions matching the workflow id specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
      パラメータ:
        `executionFilter` - If specified, only workflow executions matching the workflow id specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### withExecutionFilter

          public ListClosedWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter)

      If specified, only workflow executions matching the workflow id specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

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

      パラメータ:
        `executionFilter` - If specified, only workflow executions matching the workflow id specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### getCloseStatusFilter

          public CloseStatusFilter getCloseStatusFilter()

      If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
      戻り値:
        If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### setCloseStatusFilter

          public void setCloseStatusFilter(CloseStatusFilter closeStatusFilter)

      If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
      パラメータ:
        `closeStatusFilter` - If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### withCloseStatusFilter

          public ListClosedWorkflowExecutionsRequest withCloseStatusFilter(CloseStatusFilter closeStatusFilter)

      If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

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

      パラメータ:
        `closeStatusFilter` - If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### getTypeFilter

          public WorkflowTypeFilter getTypeFilter()

      If specified, only executions of the type specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
      戻り値:
        If specified, only executions of the type specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### setTypeFilter

          public void setTypeFilter(WorkflowTypeFilter typeFilter)

      If specified, only executions of the type specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
      パラメータ:
        `typeFilter` - If specified, only executions of the type specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### withTypeFilter

          public ListClosedWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter)

      If specified, only executions of the type specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

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

      パラメータ:
        `typeFilter` - If specified, only executions of the type specified in the filter are returned. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### getTagFilter

          public TagFilter getTagFilter()

      If specified, only executions that have the matching tag are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
      戻り値:
        If specified, only executions that have the matching tag are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### setTagFilter

          public void setTagFilter(TagFilter tagFilter)

      If specified, only executions that have the matching tag are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
      パラメータ:
        `tagFilter` - If specified, only executions that have the matching tag are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### withTagFilter

          public ListClosedWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter)

      If specified, only executions that have the matching tag are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

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

      パラメータ:
        `tagFilter` - If specified, only executions that have the matching tag are listed. `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### getNextPageToken

          public java.lang.String getNextPageToken()

      If on a previous call to this method a `NextPageToken` was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

      Constraints:
      Length: 0 - 2048

      戻り値:
        If on a previous call to this method a `NextPageToken` was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

    - #### setNextPageToken

          public void setNextPageToken(java.lang.String nextPageToken)

      If on a previous call to this method a `NextPageToken` was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

      Constraints:
      Length: 0 - 2048

      パラメータ:
        `nextPageToken` - If on a previous call to this method a `NextPageToken` was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

    - #### withNextPageToken

          public ListClosedWorkflowExecutionsRequest withNextPageToken(java.lang.String nextPageToken)

      If on a previous call to this method a `NextPageToken` was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

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

      Constraints:
      Length: 0 - 2048

      パラメータ:
        `nextPageToken` - If on a previous call to this method a `NextPageToken` was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

    - #### getMaximumPageSize

          public java.lang.Integer getMaximumPageSize()

      The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions 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

      戻り値:
        The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions 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)

      The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions 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` - The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

    - #### withMaximumPageSize

          public ListClosedWorkflowExecutionsRequest withMaximumPageSize(java.lang.Integer maximumPageSize)

      The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions 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` - The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions 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 results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
      戻り値:
        When set to `true`, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

    - #### setReverseOrder

          public void setReverseOrder(java.lang.Boolean reverseOrder)

      When set to `true`, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
      パラメータ:
        `reverseOrder` - When set to `true`, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

    - #### withReverseOrder

          public ListClosedWorkflowExecutionsRequest withReverseOrder(java.lang.Boolean reverseOrder)

      When set to `true`, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

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

      パラメータ:
        `reverseOrder` - When set to `true`, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

    - #### getReverseOrder

          public java.lang.Boolean getReverseOrder()

      When set to `true`, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
      戻り値:
        When set to `true`, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

    - #### 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`