com.amazonaws.services.simpleworkflow.model

Class ListWorkflowTypesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.ListWorkflowTypesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListWorkflowTypesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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. 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 .

See Also:

AmazonSimpleWorkflow.listWorkflowTypes(ListWorkflowTypesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListWorkflowTypesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListWorkflowTypesRequest	clone()
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListWorkflowTypesRequest

public ListWorkflowTypesRequest()

Method Detail

getDomain

public String getDomain()

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

Constraints:
Length: 1 - 256

Returns:

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

setDomain

public void setDomain(String domain)

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

Constraints:
Length: 1 - 256

Parameters:

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

withDomain

public ListWorkflowTypesRequest withDomain(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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getName

public String getName()

If specified, lists the workflow type with this name.

Constraints:
Length: 1 - 256

Returns:

If specified, lists the workflow type with this name.

setName

public void setName(String name)

If specified, lists the workflow type with this name.

Constraints:
Length: 1 - 256

Parameters:

name - If specified, lists the workflow type with this name.

withName

public ListWorkflowTypesRequest withName(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

Parameters:

name - If specified, lists the workflow type with this name.

Returns:

A reference to this updated object so that method calls can be chained together.

getRegistrationStatus

public String getRegistrationStatus()

Specifies the registration status of the workflow types to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

Returns:

Specifies the registration status of the workflow types to list.

See Also:

RegistrationStatus

setRegistrationStatus

public void setRegistrationStatus(String registrationStatus)

Specifies the registration status of the workflow types to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

Parameters:

registrationStatus - Specifies the registration status of the workflow types to list.

See Also:

RegistrationStatus

withRegistrationStatus

public ListWorkflowTypesRequest withRegistrationStatus(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

Parameters:

registrationStatus - Specifies the registration status of the workflow types to list.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

RegistrationStatus

setRegistrationStatus

public void setRegistrationStatus(RegistrationStatus registrationStatus)

Specifies the registration status of the workflow types to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

Parameters:

registrationStatus - Specifies the registration status of the workflow types to list.

See Also:

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

Parameters:

registrationStatus - Specifies the registration status of the workflow types to list.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

RegistrationStatus

getNextPageToken

public String getNextPageToken()

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.

Constraints:
Length: 0 - 2048

Returns:

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.

setNextPageToken

public void setNextPageToken(String 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.

Constraints:
Length: 0 - 2048

Parameters:

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.

withNextPageToken

public ListWorkflowTypesRequest withNextPageToken(String 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.

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

Constraints:
Length: 0 - 2048

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaximumPageSize

public Integer getMaximumPageSize()

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.

Constraints:
Range: 0 - 1000

Returns:

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.

setMaximumPageSize

public void setMaximumPageSize(Integer 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.

Constraints:
Range: 0 - 1000

Parameters:

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.

withMaximumPageSize

public ListWorkflowTypesRequest withMaximumPageSize(Integer 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.

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

Constraints:
Range: 0 - 1000

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

isReverseOrder

public 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.

Returns:

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(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.

Parameters:

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(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.

Parameters:

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 updated object so that method calls can be chained together.

getReverseOrder

public 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.

Returns:

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 String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ListWorkflowTypesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest