public class ListWorkflowTypesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
NOOP
Constructor and Description |
---|
ListWorkflowTypesRequest() |
Modifier and Type | Method and Description |
---|---|
ListWorkflowTypesRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getDomain()
The name of the domain in which the workflow types have been
registered.
|
Integer |
getMaximumPageSize()
The maximum number of results that will be returned per call.
|
String |
getName()
If specified, lists the workflow type with this name.
|
String |
getNextPageToken()
If a
NextPageToken was returned by a previous call, there
are more results available. |
String |
getRegistrationStatus()
Specifies the registration status of the workflow types to list.
|
Boolean |
getReverseOrder()
When set to
true , returns the results in reverse order. |
int |
hashCode() |
Boolean |
isReverseOrder()
When set to
true , returns the results in reverse order. |
void |
setDomain(String domain)
The name of the domain in which the workflow types have been
registered.
|
void |
setMaximumPageSize(Integer maximumPageSize)
The maximum number of results that will be returned per call.
|
void |
setName(String name)
If specified, lists the workflow type with this name.
|
void |
setNextPageToken(String nextPageToken)
If a
NextPageToken was returned by a previous call, there
are more results available. |
void |
setRegistrationStatus(RegistrationStatus registrationStatus)
Specifies the registration status of the workflow types to list.
|
void |
setRegistrationStatus(String registrationStatus)
Specifies the registration status of the workflow types to list.
|
void |
setReverseOrder(Boolean reverseOrder)
When set to
true , returns the results in reverse order. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListWorkflowTypesRequest |
withDomain(String domain)
The name of the domain in which the workflow types have been
registered.
|
ListWorkflowTypesRequest |
withMaximumPageSize(Integer maximumPageSize)
The maximum number of results that will be returned per call.
|
ListWorkflowTypesRequest |
withName(String name)
If specified, lists the workflow type with this name.
|
ListWorkflowTypesRequest |
withNextPageToken(String nextPageToken)
If a
NextPageToken was returned by a previous call, there
are more results available. |
ListWorkflowTypesRequest |
withRegistrationStatus(RegistrationStatus registrationStatus)
Specifies the registration status of the workflow types to list.
|
ListWorkflowTypesRequest |
withRegistrationStatus(String registrationStatus)
Specifies the registration status of the workflow types to list.
|
ListWorkflowTypesRequest |
withReverseOrder(Boolean reverseOrder)
When set to
true , returns the results in reverse order. |
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getDomain()
Constraints:
Length: 1 - 256
public void setDomain(String domain)
Constraints:
Length: 1 - 256
domain
- The name of the domain in which the workflow types have been
registered.public ListWorkflowTypesRequest withDomain(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 String getName()
Constraints:
Length: 1 - 256
public void setName(String name)
Constraints:
Length: 1 - 256
name
- If specified, lists the workflow type with this name.public ListWorkflowTypesRequest withName(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 String getRegistrationStatus()
Constraints:
Allowed Values: REGISTERED, DEPRECATED
RegistrationStatus
public void setRegistrationStatus(String registrationStatus)
Constraints:
Allowed Values: REGISTERED, DEPRECATED
registrationStatus
- Specifies the registration status of the workflow types to list.RegistrationStatus
public ListWorkflowTypesRequest withRegistrationStatus(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.RegistrationStatus
public void setRegistrationStatus(RegistrationStatus registrationStatus)
Constraints:
Allowed Values: REGISTERED, DEPRECATED
registrationStatus
- Specifies the registration status of the workflow types to list.RegistrationStatus
public 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.RegistrationStatus
public String getNextPageToken()
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
public void setNextPageToken(String nextPageToken)
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
nextPageToken
- If a NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
public ListWorkflowTypesRequest withNextPageToken(String nextPageToken)
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 2048
nextPageToken
- If a NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
public Integer getMaximumPageSize()
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
public void setMaximumPageSize(Integer maximumPageSize)
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
maximumPageSize
- The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
public ListWorkflowTypesRequest withMaximumPageSize(Integer maximumPageSize)
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 - 1000
maximumPageSize
- The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
public 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(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(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 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 String toString()
toString
in class Object
Object.toString()
public ListWorkflowTypesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.