public class ListActivityTypesRequest extends AmazonWebServiceRequest implements java.io.Serializable
ListActivityTypes operation.
Returns information about all activities registered in the specified domain that match the specified name and registration status. The result
includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent
pages, make the call again using the nextPageToken returned by the initial call.
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 .
| コンストラクタと説明 |
|---|
ListActivityTypesRequest() |
| 修飾子とタイプ | メソッドと説明 |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDomain()
The name of the domain in which the activity types have been
registered.
|
java.lang.Integer |
getMaximumPageSize()
The maximum number of results returned in each page.
|
java.lang.String |
getName()
If specified, only lists the activity types that have this name.
|
java.lang.String |
getNextPageToken()
If on a previous call to this method a
NextResultToken
was returned, the results have more than one page. |
java.lang.String |
getRegistrationStatus()
Specifies the registration status of the activity 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 activity 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, only lists the activity types that have this name.
|
void |
setNextPageToken(java.lang.String nextPageToken)
If on a previous call to this method a
NextResultToken
was returned, the results have more than one page. |
void |
setRegistrationStatus(RegistrationStatus registrationStatus)
Specifies the registration status of the activity types to list.
|
void |
setRegistrationStatus(java.lang.String registrationStatus)
Specifies the registration status of the activity 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.
|
ListActivityTypesRequest |
withDomain(java.lang.String domain)
The name of the domain in which the activity types have been
registered.
|
ListActivityTypesRequest |
withMaximumPageSize(java.lang.Integer maximumPageSize)
The maximum number of results returned in each page.
|
ListActivityTypesRequest |
withName(java.lang.String name)
If specified, only lists the activity types that have this name.
|
ListActivityTypesRequest |
withNextPageToken(java.lang.String nextPageToken)
If on a previous call to this method a
NextResultToken
was returned, the results have more than one page. |
ListActivityTypesRequest |
withRegistrationStatus(RegistrationStatus registrationStatus)
Specifies the registration status of the activity types to list.
|
ListActivityTypesRequest |
withRegistrationStatus(java.lang.String registrationStatus)
Specifies the registration status of the activity types to list.
|
ListActivityTypesRequest |
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 activity types have been
registered.public ListActivityTypesRequest 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 activity 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, only lists the activity types that have this name.public ListActivityTypesRequest 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, only lists the activity types that have 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 activity types to list.RegistrationStatuspublic ListActivityTypesRequest 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 activity types to list.RegistrationStatuspublic void setRegistrationStatus(RegistrationStatus registrationStatus)
Constraints:
Allowed Values: REGISTERED, DEPRECATED
registrationStatus - Specifies the registration status of the activity types to list.RegistrationStatuspublic ListActivityTypesRequest 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 activity types to list.RegistrationStatuspublic java.lang.String getNextPageToken()
NextResultToken
was returned, the results have more than one page. To get the next
page of results, repeat the call with the nextPageToken
and keep all other arguments unchanged.
Constraints:
Length: 0 - 2048
NextResultToken
was returned, the results have more than one page. To get the next
page of results, repeat the call with the nextPageToken
and keep all other arguments unchanged.public void setNextPageToken(java.lang.String nextPageToken)
NextResultToken
was returned, the results have more than one page. To get the next
page of results, repeat the call with the nextPageToken
and keep all other arguments unchanged.
Constraints:
Length: 0 - 2048
nextPageToken - If on a previous call to this method a NextResultToken
was returned, the results have more than one page. To get the next
page of results, repeat the call with the nextPageToken
and keep all other arguments unchanged.public ListActivityTypesRequest withNextPageToken(java.lang.String nextPageToken)
NextResultToken
was returned, the results have more than one page. To get the next
page of results, repeat the call with the nextPageToken
and keep 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 NextResultToken
was returned, the results have more than one page. To get the next
page of results, repeat the call with the nextPageToken
and keep 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 ListActivityTypesRequest 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 activity types.true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the activity 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 activity 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 activity types.public ListActivityTypesRequest 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 activity 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 activity 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 activity types.true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the activity 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