com.amazonaws.services.simpleworkflow.model

## クラス ListWorkflowTypesRequest

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

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

      public class ListWorkflowTypesRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `ListWorkflowTypes operation`.

  Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getDomain()` The name of the domain in which the workflow types have been registered.
    `java.lang.Integer` | `getMaximumPageSize()` The maximum number of results returned in each page.
    `java.lang.String` | `getName()` If specified, lists the workflow type with this name.
    `java.lang.String` | `getNextPageToken()` If on a previous call to this method a `NextPageToken` was returned, the results are being paginated.
    `java.lang.String` | `getRegistrationStatus()` Specifies the registration status of the workflow types to list.
    `java.lang.Boolean` | `getReverseOrder()` When set to `true`, returns the results in reverse order.
    `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 in which the workflow types have been registered.
    `void` | `setMaximumPageSize(java.lang.Integer maximumPageSize)` The maximum number of results returned in each page.
    `void` | `setName(java.lang.String name)` If specified, lists the workflow type with this name.
    `void` | `setNextPageToken(java.lang.String nextPageToken)` If on a previous call to this method a `NextPageToken` was returned, the results are being paginated.
    `void` | `setRegistrationStatus(RegistrationStatus registrationStatus)` Specifies the registration status of the workflow types to list.
    `void` | `setRegistrationStatus(java.lang.String registrationStatus)` Specifies the registration status of the workflow types to list.
    `void` | `setReverseOrder(java.lang.Boolean reverseOrder)` When set to `true`, returns the results in reverse order.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `ListWorkflowTypesRequest` | `withDomain(java.lang.String domain)` The name of the domain in which the workflow types have been registered.
    `ListWorkflowTypesRequest` | `withMaximumPageSize(java.lang.Integer maximumPageSize)` The maximum number of results returned in each page.
    `ListWorkflowTypesRequest` | `withName(java.lang.String name)` If specified, lists the workflow type with this name.
    `ListWorkflowTypesRequest` | `withNextPageToken(java.lang.String nextPageToken)` If on a previous call to this method a `NextPageToken` was returned, the results are being paginated.
    `ListWorkflowTypesRequest` | `withRegistrationStatus(RegistrationStatus registrationStatus)` Specifies the registration status of the workflow types to list.
    `ListWorkflowTypesRequest` | `withRegistrationStatus(java.lang.String registrationStatus)` Specifies the registration status of the workflow types to list.
    `ListWorkflowTypesRequest` | `withReverseOrder(java.lang.Boolean reverseOrder)` When set to `true`, returns the results in reverse order.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### ListWorkflowTypesRequest

          public ListWorkflowTypesRequest()

  - ### メソッドの詳細

    - #### getDomain

          public java.lang.String getDomain()

      The name of the domain in which the workflow types have been registered.

      Constraints:
      Length: 1 - 256

      戻り値:
        The name of the domain in which the workflow types have been registered.

    - #### setDomain

          public void setDomain(java.lang.String domain)

      The name of the domain in which the workflow types have been registered.

      Constraints:
      Length: 1 - 256

      パラメータ:
        `domain` - The name of the domain in which the workflow types have been registered.

    - #### withDomain

          public ListWorkflowTypesRequest withDomain(java.lang.String domain)

      The name of the domain in which the workflow types have been registered.

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

      Constraints:
      Length: 1 - 256

      パラメータ:
        `domain` - The name of the domain in which the workflow types have been registered.

    - #### getName

          public java.lang.String getName()

      If specified, lists the workflow type with this name.

      Constraints:
      Length: 1 - 256

      戻り値:
        If specified, lists the workflow type with this name.

    - #### setName

          public void setName(java.lang.String name)

      If specified, lists the workflow type with this name.

      Constraints:
      Length: 1 - 256

      パラメータ:
        `name` - If specified, lists the workflow type with this name.

    - #### withName

          public ListWorkflowTypesRequest withName(java.lang.String name)

      If specified, lists the workflow type with this name.

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

      Constraints:
      Length: 1 - 256

      パラメータ:
        `name` - If specified, lists the workflow type with this name.

    - #### getRegistrationStatus

          public java.lang.String getRegistrationStatus()

      Specifies the registration status of the workflow types to list.

      Constraints:
      Allowed Values: REGISTERED, DEPRECATED

      戻り値:
        Specifies the registration status of the workflow types to list.
      関連項目:
        `RegistrationStatus`

    - #### setRegistrationStatus

          public void setRegistrationStatus(java.lang.String registrationStatus)

      Specifies the registration status of the workflow types to list.

      Constraints:
      Allowed Values: REGISTERED, DEPRECATED

      パラメータ:
        `registrationStatus` - Specifies the registration status of the workflow types to list.
      関連項目:
        `RegistrationStatus`

    - #### withRegistrationStatus

          public ListWorkflowTypesRequest withRegistrationStatus(java.lang.String registrationStatus)

      Specifies the registration status of the workflow types to list.

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

      Constraints:
      Allowed Values: REGISTERED, DEPRECATED

      パラメータ:
        `registrationStatus` - Specifies the registration status of the workflow types to list.
      関連項目:
        `RegistrationStatus`

    - #### setRegistrationStatus

          public void setRegistrationStatus(RegistrationStatus registrationStatus)

      Specifies the registration status of the workflow types to list.

      Constraints:
      Allowed Values: REGISTERED, DEPRECATED

      パラメータ:
        `registrationStatus` - Specifies the registration status of the workflow types to list.
      関連項目:
        `RegistrationStatus`

    - #### withRegistrationStatus

          public ListWorkflowTypesRequest withRegistrationStatus(RegistrationStatus registrationStatus)

      Specifies the registration status of the workflow types to list.

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

      Constraints:
      Allowed Values: REGISTERED, DEPRECATED

      パラメータ:
        `registrationStatus` - Specifies the registration status of the workflow types to list.
      関連項目:
        `RegistrationStatus`

    - #### 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 ListWorkflowTypesRequest 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 types 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 types 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 types 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 types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

    - #### withMaximumPageSize

          public ListWorkflowTypesRequest 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 types 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 types 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 ascending alphabetical order of the `name` of the workflow types.
      戻り値:
        When set to `true`, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the `name` of the workflow types.

    - #### 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 ascending alphabetical order of the `name` of the workflow types.
      パラメータ:
        `reverseOrder` - When set to `true`, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the `name` of the workflow types.

    - #### withReverseOrder

          public ListWorkflowTypesRequest withReverseOrder(java.lang.Boolean reverseOrder)

      When set to `true`, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the `name` of the workflow types.

      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 ascending alphabetical order of the `name` of the workflow types.

    - #### getReverseOrder

          public java.lang.Boolean getReverseOrder()

      When set to `true`, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the `name` of the workflow types.
      戻り値:
        When set to `true`, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the `name` of the workflow types.

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