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

The DescribeSnapshots action returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

 
 public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
 
     private String cacheClusterId;

    
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
 
     private String snapshotName;

    
If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
 
     private String snapshotSource;

    
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;

    
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: 50

Constraints: minimum 20; maximum 50.

 
     private Integer maxRecords;

    
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

Returns:
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
 
     public String getCacheClusterId() {
         return ;
     }
    
    
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

Parameters:
cacheClusterId A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
 
     public void setCacheClusterId(String cacheClusterId) {
         this. = cacheClusterId;
     }
    
    
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

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

Parameters:
cacheClusterId A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeSnapshotsRequest withCacheClusterId(String cacheClusterId) {
        this. = cacheClusterId;
        return this;
    }

    
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

Returns:
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
    public String getSnapshotName() {
        return ;
    }
    
    
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

Parameters:
snapshotName A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
    public void setSnapshotName(String snapshotName) {
        this. = snapshotName;
    }
    
    
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

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

Parameters:
snapshotName A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeSnapshotsRequest withSnapshotName(String snapshotName) {
        this. = snapshotName;
        return this;
    }

    
If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Returns:
If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
    public String getSnapshotSource() {
        return ;
    }
    
    
If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Parameters:
snapshotSource If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
    public void setSnapshotSource(String snapshotSource) {
        this. = snapshotSource;
    }
    
    
If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

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

Parameters:
snapshotSource If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeSnapshotsRequest withSnapshotSource(String snapshotSource) {
        this. = snapshotSource;
        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.
    public DescribeSnapshotsRequest withMarker(String marker) {
        this. = marker;
        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: 50

Constraints: minimum 20; maximum 50.

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: 50

Constraints: minimum 20; maximum 50.

    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: 50

Constraints: minimum 20; maximum 50.

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: 50

Constraints: minimum 20; maximum 50.

    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: 50

Constraints: minimum 20; maximum 50.

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: 50

Constraints: minimum 20; maximum 50.

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

    
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 (getSnapshotName() != nullsb.append("SnapshotName: " + getSnapshotName() + ",");
        if (getSnapshotSource() != nullsb.append("SnapshotSource: " + getSnapshotSource() + ",");
        if (getMarker() != nullsb.append("Marker: " + getMarker() + ",");
        if (getMaxRecords() != nullsb.append("MaxRecords: " + getMaxRecords() );
        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 + ((getSnapshotName() == null) ? 0 : getSnapshotName().hashCode()); 
        hashCode = prime * hashCode + ((getSnapshotSource() == null) ? 0 : getSnapshotSource().hashCode()); 
        hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); 
        hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof DescribeSnapshotsRequest == falsereturn false;
        DescribeSnapshotsRequest other = (DescribeSnapshotsRequest)obj;
        
        if (other.getCacheClusterId() == null ^ this.getCacheClusterId() == nullreturn false;
        if (other.getCacheClusterId() != null && other.getCacheClusterId().equals(this.getCacheClusterId()) == falsereturn false
        if (other.getSnapshotName() == null ^ this.getSnapshotName() == nullreturn false;
        if (other.getSnapshotName() != null && other.getSnapshotName().equals(this.getSnapshotName()) == falsereturn false
        if (other.getSnapshotSource() == null ^ this.getSnapshotSource() == nullreturn false;
        if (other.getSnapshotSource() != null && other.getSnapshotSource().equals(this.getSnapshotSource()) == falsereturn false
        if (other.getMarker() == null ^ this.getMarker() == nullreturn false;
        if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == falsereturn false
        if (other.getMaxRecords() == null ^ this.getMaxRecords() == nullreturn false;
        if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == falsereturn false
        return true;
    }
    
    @Override
    public DescribeSnapshotsRequest clone() {
        
            return (DescribeSnapshotsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X