public class ListWorkflowTypesRequest extends AmazonWebServiceRequest implements java.io.Serializable
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:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.
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 .
| コンストラクタと説明 |
|---|
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. |
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentialspublic java.lang.String getDomain()
Constraints:
Length: 1 - 256
public void setDomain(java.lang.String domain)
Constraints:
Length: 1 - 256
domain - The name of the domain in which the workflow types have been
registered.public ListWorkflowTypesRequest withDomain(java.lang.String domain)
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.public java.lang.String getName()
Constraints:
Length: 1 - 256
public void setName(java.lang.String name)
Constraints:
Length: 1 - 256
name - If specified, lists the workflow type with this name.public ListWorkflowTypesRequest withName(java.lang.String 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.public java.lang.String getRegistrationStatus()
Constraints:
Allowed Values: REGISTERED, DEPRECATED
RegistrationStatuspublic void setRegistrationStatus(java.lang.String registrationStatus)
Constraints:
Allowed Values: REGISTERED, DEPRECATED
registrationStatus - Specifies the registration status of the workflow types to list.RegistrationStatuspublic ListWorkflowTypesRequest withRegistrationStatus(java.lang.String registrationStatus)
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.RegistrationStatuspublic void setRegistrationStatus(RegistrationStatus registrationStatus)
Constraints:
Allowed Values: REGISTERED, DEPRECATED
registrationStatus - Specifies the registration status of the workflow types to list.RegistrationStatuspublic ListWorkflowTypesRequest withRegistrationStatus(RegistrationStatus registrationStatus)
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.RegistrationStatuspublic java.lang.String getNextPageToken()
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 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.public void setNextPageToken(java.lang.String nextPageToken)
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.public ListWorkflowTypesRequest withNextPageToken(java.lang.String nextPageToken)
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.public java.lang.Integer getMaximumPageSize()
Constraints:
Range: 0 - 1000
public void setMaximumPageSize(java.lang.Integer maximumPageSize)
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.public ListWorkflowTypesRequest withMaximumPageSize(java.lang.Integer maximumPageSize)
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.public java.lang.Boolean isReverseOrder()
true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the workflow types.true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the workflow types.public void setReverseOrder(java.lang.Boolean reverseOrder)
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.public ListWorkflowTypesRequest withReverseOrder(java.lang.Boolean reverseOrder)
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.public java.lang.Boolean getReverseOrder()
true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the workflow types.true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the workflow types.public java.lang.String toString()
toString クラス内 java.lang.ObjectObject.toString()public int hashCode()
hashCode クラス内 java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals クラス内 java.lang.Object