com.amazonaws.services.simpleworkflow.model

Class ListDomainsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.ListDomainsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListDomainsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListDomains operation.

Returns the list of domains registered in the account. 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. The element must be set to arn:aws:swf::AccountID:domain/* , where AccountID is the account ID, with no dashes.
• 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.listDomains(ListDomainsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListDomainsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListDomainsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getMaximumPageSize() The maximum number of results that will be returned per call.
String	getNextPageToken() If a NextPageToken was returned by a previous call, there are more results available.
String	getRegistrationStatus() Specifies the registration status of the domains 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	setMaximumPageSize(Integer maximumPageSize) The maximum number of results that will be returned per call.
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 domains to list.
void	setRegistrationStatus(String registrationStatus) Specifies the registration status of the domains 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.
ListDomainsRequest	withMaximumPageSize(Integer maximumPageSize) The maximum number of results that will be returned per call.
ListDomainsRequest	withNextPageToken(String nextPageToken) If a NextPageToken was returned by a previous call, there are more results available.
ListDomainsRequest	withRegistrationStatus(RegistrationStatus registrationStatus) Specifies the registration status of the domains to list.
ListDomainsRequest	withRegistrationStatus(String registrationStatus) Specifies the registration status of the domains to list.
ListDomainsRequest	withReverseOrder(Boolean reverseOrder) When set to true, returns the results in reverse order.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListDomainsRequest

public ListDomainsRequest()

Method Detail

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

getRegistrationStatus

public String getRegistrationStatus()

Specifies the registration status of the domains to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

Returns:

Specifies the registration status of the domains to list.

See Also:

RegistrationStatus

setRegistrationStatus

public void setRegistrationStatus(String registrationStatus)

Specifies the registration status of the domains to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

Parameters:

registrationStatus - Specifies the registration status of the domains to list.

See Also:

RegistrationStatus

withRegistrationStatus

public ListDomainsRequest withRegistrationStatus(String registrationStatus)

Specifies the registration status of the domains 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 domains 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 domains to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

Parameters:

registrationStatus - Specifies the registration status of the domains to list.

See Also:

RegistrationStatus

withRegistrationStatus

public ListDomainsRequest withRegistrationStatus(RegistrationStatus registrationStatus)

Specifies the registration status of the domains 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 domains to list.

Returns:

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

See Also:

RegistrationStatus

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 ListDomainsRequest 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 by name of the domains.

Returns:

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

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 by name of the domains.

Parameters:

reverseOrder - When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

withReverseOrder

public ListDomainsRequest withReverseOrder(Boolean reverseOrder)

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

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 by name of the domains.

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 by name of the domains.

Returns:

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

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 ListDomainsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()