com.amazonaws.services.simpleworkflow.model

## クラス ListOpenWorkflowExecutionsRequest

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

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

      public class ListOpenWorkflowExecutionsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `ListOpenWorkflowExecutions operation`.

  Returns a list of open 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.listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest)`, 直列化された形式

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `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()` 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` | `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)` 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.
    `ListOpenWorkflowExecutionsRequest` | `withDomain(java.lang.String domain)` The name of the domain that contains the workflow executions to list.
    `ListOpenWorkflowExecutionsRequest` | `withExecutionFilter(WorkflowExecutionFilter executionFilter)` If specified, only workflow executions matching the workflow id specified in the filter are returned.
    `ListOpenWorkflowExecutionsRequest` | `withMaximumPageSize(java.lang.Integer maximumPageSize)` The maximum number of results returned in each page.
    `ListOpenWorkflowExecutionsRequest` | `withNextPageToken(java.lang.String nextPageToken)` If on a previous call to this method a `NextPageToken` was returned, the results are being paginated.
    `ListOpenWorkflowExecutionsRequest` | `withReverseOrder(java.lang.Boolean reverseOrder)` When set to `true`, returns the results in reverse order.
    `ListOpenWorkflowExecutionsRequest` | `withStartTimeFilter(ExecutionTimeFilter startTimeFilter)` Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
    `ListOpenWorkflowExecutionsRequest` | `withTagFilter(TagFilter tagFilter)` If specified, only executions that have the matching tag are listed.
    `ListOpenWorkflowExecutionsRequest` | `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`

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

    - #### ListOpenWorkflowExecutionsRequest

          public ListOpenWorkflowExecutionsRequest()

  - ### メソッドの詳細

    - #### 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 ListOpenWorkflowExecutionsRequest 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()

      Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
      戻り値:
        Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

    - #### setStartTimeFilter

          public void setStartTimeFilter(ExecutionTimeFilter startTimeFilter)

      Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
      パラメータ:
        `startTimeFilter` - Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

    - #### withStartTimeFilter

          public ListOpenWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter)

      Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

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

      パラメータ:
        `startTimeFilter` - Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

    - #### getTypeFilter

          public WorkflowTypeFilter getTypeFilter()

      If specified, only executions of the type specified in the filter are returned. `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. `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. `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. `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### withTypeFilter

          public ListOpenWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter)

      If specified, only executions of the type specified in the filter are returned. `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. `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. `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. `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. `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. `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### withTagFilter

          public ListOpenWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter)

      If specified, only executions that have the matching tag are listed. `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. `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 ListOpenWorkflowExecutionsRequest 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 ListOpenWorkflowExecutionsRequest 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 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 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 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 time of the executions.

    - #### withReverseOrder

          public ListOpenWorkflowExecutionsRequest 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 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 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 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 time of the executions.

    - #### getExecutionFilter

          public WorkflowExecutionFilter getExecutionFilter()

      If specified, only workflow executions matching the workflow id specified in the filter are returned. `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. `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. `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. `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

    - #### withExecutionFilter

          public ListOpenWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter)

      If specified, only workflow executions matching the workflow id specified in the filter are returned. `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. `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

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