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.elasticache.model;
 
 
Container for the parameters to the DescribeCacheClusters operation.

The DescribeCacheClusters action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

 
 public class DescribeCacheClustersRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.
 
     private String cacheClusterId;

    
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

 
     private Integer maxRecords;

    
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
 
     private String marker;

    
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
 
     private Boolean showCacheNodeInfo;

    
Default constructor for a new DescribeCacheClustersRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
 
     public DescribeCacheClustersRequest() {}
    
    
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

Returns:
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.
    public String getCacheClusterId() {
        return ;
    }
    
    
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

Parameters:
cacheClusterId The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.
    public void setCacheClusterId(String cacheClusterId) {
        this. = cacheClusterId;
    }
    
    
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

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

Parameters:
cacheClusterId The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeCacheClustersRequest withCacheClusterId(String cacheClusterId) {
        this. = cacheClusterId;
        return this;
    }

    
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Returns:
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

    public Integer getMaxRecords() {
        return ;
    }
    
    
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Parameters:
maxRecords The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

    public void setMaxRecords(Integer maxRecords) {
        this. = maxRecords;
    }
    
    
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

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

Parameters:
maxRecords The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeCacheClustersRequest withMaxRecords(Integer maxRecords) {
        this. = maxRecords;
        return this;
    }

    
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    public String getMarker() {
        return ;
    }
    
    
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters:
marker An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    public void setMarker(String marker) {
        this. = marker;
    }
    
    
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

Parameters:
marker An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = marker;
        return this;
    }

    
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Returns:
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
    public Boolean isShowCacheNodeInfo() {
        return ;
    }
    
    
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Parameters:
showCacheNodeInfo An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
    public void setShowCacheNodeInfo(Boolean showCacheNodeInfo) {
        this. = showCacheNodeInfo;
    }
    
    
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

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

Parameters:
showCacheNodeInfo An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeCacheClustersRequest withShowCacheNodeInfo(Boolean showCacheNodeInfo) {
        this. = showCacheNodeInfo;
        return this;
    }

    
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Returns:
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
    public Boolean getShowCacheNodeInfo() {
        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 (getCacheClusterId() != nullsb.append("CacheClusterId: " + getCacheClusterId() + ",");
        if (getMaxRecords() != nullsb.append("MaxRecords: " + getMaxRecords() + ",");
        if (getMarker() != nullsb.append("Marker: " + getMarker() + ",");
        if (isShowCacheNodeInfo() != nullsb.append("ShowCacheNodeInfo: " + isShowCacheNodeInfo() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getCacheClusterId() == null) ? 0 : getCacheClusterId().hashCode()); 
        hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode()); 
        hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); 
        hashCode = prime * hashCode + ((isShowCacheNodeInfo() == null) ? 0 : isShowCacheNodeInfo().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof DescribeCacheClustersRequest == falsereturn false;
        
        if (other.getCacheClusterId() == null ^ this.getCacheClusterId() == nullreturn false;
        if (other.getCacheClusterId() != null && other.getCacheClusterId().equals(this.getCacheClusterId()) == falsereturn false
        if (other.getMaxRecords() == null ^ this.getMaxRecords() == nullreturn false;
        if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == falsereturn false
        if (other.getMarker() == null ^ this.getMarker() == nullreturn false;
        if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == falsereturn false
        if (other.isShowCacheNodeInfo() == null ^ this.isShowCacheNodeInfo() == nullreturn false;
        if (other.isShowCacheNodeInfo() != null && other.isShowCacheNodeInfo().equals(this.isShowCacheNodeInfo()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (DescribeCacheClustersRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X