Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.simpleworkflow.model;
 
 
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 .

 
 public class ListDomainsRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
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

 
     private String nextPageToken;

    
Specifies the registration status of the domains to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

 
     private String registrationStatus;

    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

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

 
     private Integer maximumPageSize;

    
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.
    private Boolean reverseOrder;

    
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.

    public String getNextPageToken() {
        return ;
    }
    
    
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.

    public void setNextPageToken(String nextPageToken) {
        this. = 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.
    public ListDomainsRequest withNextPageToken(String nextPageToken) {
        this. = nextPageToken;
        return this;
    }

    
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
    public String getRegistrationStatus() {
        return ;
    }
    
    
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
    public void setRegistrationStatus(String registrationStatus) {
        this. = 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
    public ListDomainsRequest withRegistrationStatus(String registrationStatus) {
        this. = registrationStatus;
        return this;
    }

    
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
    public void setRegistrationStatus(RegistrationStatus registrationStatus) {
        this. = registrationStatus.toString();
    }
    
    
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
    public ListDomainsRequest withRegistrationStatus(RegistrationStatus registrationStatus) {
        this. = registrationStatus.toString();
        return this;
    }

    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

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 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

    public Integer getMaximumPageSize() {
        return ;
    }
    
    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

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 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

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) {
        this. = 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 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

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 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

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.
    public ListDomainsRequest withMaximumPageSize(Integer maximumPageSize) {
        this. = maximumPageSize;
        return this;
    }

    
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.
    public Boolean isReverseOrder() {
        return ;
    }
    
    
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.
    public void setReverseOrder(Boolean reverseOrder) {
        this. = 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.
    public ListDomainsRequest withReverseOrder(Boolean reverseOrder) {
        this. = reverseOrder;
        return this;
    }

    
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.
    public Boolean getReverseOrder() {
        return ;
    }

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

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getNextPageToken() != nullsb.append("NextPageToken: " + getNextPageToken() + ",");
        if (getRegistrationStatus() != nullsb.append("RegistrationStatus: " + getRegistrationStatus() + ",");
        if (getMaximumPageSize() != nullsb.append("MaximumPageSize: " + getMaximumPageSize() + ",");
        if (isReverseOrder() != nullsb.append("ReverseOrder: " + isReverseOrder() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getNextPageToken() == null) ? 0 : getNextPageToken().hashCode()); 
        hashCode = prime * hashCode + ((getRegistrationStatus() == null) ? 0 : getRegistrationStatus().hashCode()); 
        hashCode = prime * hashCode + ((getMaximumPageSize() == null) ? 0 : getMaximumPageSize().hashCode()); 
        hashCode = prime * hashCode + ((isReverseOrder() == null) ? 0 : isReverseOrder().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof ListDomainsRequest == falsereturn false;
        ListDomainsRequest other = (ListDomainsRequest)obj;
        
        if (other.getNextPageToken() == null ^ this.getNextPageToken() == nullreturn false;
        if (other.getNextPageToken() != null && other.getNextPageToken().equals(this.getNextPageToken()) == falsereturn false
        if (other.getRegistrationStatus() == null ^ this.getRegistrationStatus() == nullreturn false;
        if (other.getRegistrationStatus() != null && other.getRegistrationStatus().equals(this.getRegistrationStatus()) == falsereturn false
        if (other.getMaximumPageSize() == null ^ this.getMaximumPageSize() == nullreturn false;
        if (other.getMaximumPageSize() != null && other.getMaximumPageSize().equals(this.getMaximumPageSize()) == falsereturn false
        if (other.isReverseOrder() == null ^ this.isReverseOrder() == nullreturn false;
        if (other.isReverseOrder() != null && other.isReverseOrder().equals(this.isReverseOrder()) == falsereturn false
        return true;
    }
    
    @Override
    public ListDomainsRequest clone() {
        
            return (ListDomainsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X