com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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.rds.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.rds.AmazonRDS#describeDBSnapshots(DescribeDBSnapshotsRequest) DescribeDBSnapshots operation}.
*
* Returns information about DB snapshots. This API supports pagination.
*
*
* @see com.amazonaws.services.rds.AmazonRDS#describeDBSnapshots(DescribeDBSnapshotsRequest)
*/
public class DescribeDBSnapshotsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A DB instance identifier to retrieve the list of DB snapshots for.
* Cannot be used in conjunction with DBSnapshotIdentifier.
* This parameter is not case sensitive. Constraints:
- Must
* contain from 1 to 63 alphanumeric characters or hyphens
- First
* character must be a letter
- Cannot end with a hyphen or
* contain two consecutive hyphens
*/
private String dBInstanceIdentifier;
/**
* A specific DB snapshot identifier to describe. Cannot be used in
* conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string. Constraints:
- Must be 1 to
* 255 alphanumeric characters
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
- If this is the identifier of an automated snapshot,
* the
SnapshotType parameter must also be specified.
*
*/
private String dBSnapshotIdentifier;
/**
* The type of snapshots that will be returned. Values can be "automated"
* or "manual." If not specified, the returned results will include all
* snapshots types.
*/
private String snapshotType;
/**
* This parameter is not currently supported.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag filters;
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so that
* the remaining results may be retrieved. Default: 100
*
Constraints: minimum 20, maximum 100
*/
private Integer maxRecords;
/**
* An optional pagination token provided by a previous
* DescribeDBSnapshots request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
private String marker;
/**
* Default constructor for a new DescribeDBSnapshotsRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DescribeDBSnapshotsRequest() {}
/**
* A DB instance identifier to retrieve the list of DB snapshots for.
* Cannot be used in conjunction with DBSnapshotIdentifier.
* This parameter is not case sensitive.
Constraints:
- Must
* contain from 1 to 63 alphanumeric characters or hyphens
- First
* character must be a letter
- Cannot end with a hyphen or
* contain two consecutive hyphens
*
* @return A DB instance identifier to retrieve the list of DB snapshots for.
* Cannot be used in conjunction with DBSnapshotIdentifier.
* This parameter is not case sensitive. Constraints:
- Must
* contain from 1 to 63 alphanumeric characters or hyphens
- First
* character must be a letter
- Cannot end with a hyphen or
* contain two consecutive hyphens
*/
public String getDBInstanceIdentifier() {
return dBInstanceIdentifier;
}
/**
* A DB instance identifier to retrieve the list of DB snapshots for.
* Cannot be used in conjunction with DBSnapshotIdentifier.
* This parameter is not case sensitive. Constraints:
- Must
* contain from 1 to 63 alphanumeric characters or hyphens
- First
* character must be a letter
- Cannot end with a hyphen or
* contain two consecutive hyphens
*
* @param dBInstanceIdentifier A DB instance identifier to retrieve the list of DB snapshots for.
* Cannot be used in conjunction with DBSnapshotIdentifier.
* This parameter is not case sensitive. Constraints:
- Must
* contain from 1 to 63 alphanumeric characters or hyphens
- First
* character must be a letter
- Cannot end with a hyphen or
* contain two consecutive hyphens
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
}
/**
* A DB instance identifier to retrieve the list of DB snapshots for.
* Cannot be used in conjunction with DBSnapshotIdentifier.
* This parameter is not case sensitive. Constraints:
- Must
* contain from 1 to 63 alphanumeric characters or hyphens
- First
* character must be a letter
- Cannot end with a hyphen or
* contain two consecutive hyphens
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dBInstanceIdentifier A DB instance identifier to retrieve the list of DB snapshots for.
* Cannot be used in conjunction with DBSnapshotIdentifier.
* This parameter is not case sensitive.
Constraints:
- Must
* contain from 1 to 63 alphanumeric characters or hyphens
- First
* character must be a letter
- Cannot end with a hyphen or
* contain two consecutive hyphens
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBSnapshotsRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
return this;
}
/**
* A specific DB snapshot identifier to describe. Cannot be used in
* conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string. Constraints:
- Must be 1 to
* 255 alphanumeric characters
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
- If this is the identifier of an automated snapshot,
* the
SnapshotType parameter must also be specified.
*
*
* @return A specific DB snapshot identifier to describe. Cannot be used in
* conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string. Constraints:
- Must be 1 to
* 255 alphanumeric characters
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
- If this is the identifier of an automated snapshot,
* the
SnapshotType parameter must also be specified.
*
*/
public String getDBSnapshotIdentifier() {
return dBSnapshotIdentifier;
}
/**
* A specific DB snapshot identifier to describe. Cannot be used in
* conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string. Constraints:
- Must be 1 to
* 255 alphanumeric characters
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
- If this is the identifier of an automated snapshot,
* the
SnapshotType parameter must also be specified.
*
*
* @param dBSnapshotIdentifier A specific DB snapshot identifier to describe. Cannot be used in
* conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string. Constraints:
- Must be 1 to
* 255 alphanumeric characters
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
- If this is the identifier of an automated snapshot,
* the
SnapshotType parameter must also be specified.
*
*/
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier) {
this.dBSnapshotIdentifier = dBSnapshotIdentifier;
}
/**
* A specific DB snapshot identifier to describe. Cannot be used in
* conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string. Constraints:
- Must be 1 to
* 255 alphanumeric characters
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
- If this is the identifier of an automated snapshot,
* the
SnapshotType parameter must also be specified.
*
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dBSnapshotIdentifier A specific DB snapshot identifier to describe. Cannot be used in
* conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string.
Constraints:
- Must be 1 to
* 255 alphanumeric characters
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
- If this is the identifier of an automated snapshot,
* the
SnapshotType parameter must also be specified.
*
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBSnapshotsRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier) {
this.dBSnapshotIdentifier = dBSnapshotIdentifier;
return this;
}
/**
* The type of snapshots that will be returned. Values can be "automated"
* or "manual." If not specified, the returned results will include all
* snapshots types.
*
* @return The type of snapshots that will be returned. Values can be "automated"
* or "manual." If not specified, the returned results will include all
* snapshots types.
*/
public String getSnapshotType() {
return snapshotType;
}
/**
* The type of snapshots that will be returned. Values can be "automated"
* or "manual." If not specified, the returned results will include all
* snapshots types.
*
* @param snapshotType The type of snapshots that will be returned. Values can be "automated"
* or "manual." If not specified, the returned results will include all
* snapshots types.
*/
public void setSnapshotType(String snapshotType) {
this.snapshotType = snapshotType;
}
/**
* The type of snapshots that will be returned. Values can be "automated"
* or "manual." If not specified, the returned results will include all
* snapshots types.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param snapshotType The type of snapshots that will be returned. Values can be "automated"
* or "manual." If not specified, the returned results will include all
* snapshots types.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBSnapshotsRequest withSnapshotType(String snapshotType) {
this.snapshotType = snapshotType;
return this;
}
/**
* This parameter is not currently supported.
*
* @return This parameter is not currently supported.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.ListWithAutoConstructFlag();
filters.setAutoConstruct(true);
}
return filters;
}
/**
* This parameter is not currently supported.
*
* @param filters This parameter is not currently supported.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
/**
* This parameter is not currently supported.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters This parameter is not currently supported.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBSnapshotsRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayList(filters.length));
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* This parameter is not currently supported.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters This parameter is not currently supported.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBSnapshotsRequest withFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
return this;
}
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so that
* the remaining results may be retrieved. Default: 100
*
Constraints: minimum 20, maximum 100
*
* @return The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so that
* the remaining results may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so that
* the remaining results may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*
* @param maxRecords The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so that
* the remaining results may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so that
* the remaining results may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxRecords The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so that
* the remaining results may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBSnapshotsRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* An optional pagination token provided by a previous
* DescribeDBSnapshots request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @return An optional pagination token provided by a previous
* DescribeDBSnapshots request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
public String getMarker() {
return marker;
}
/**
* An optional pagination token provided by a previous
* DescribeDBSnapshots request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @param marker An optional pagination token provided by a previous
* DescribeDBSnapshots request. 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 = marker;
}
/**
* An optional pagination token provided by a previous
* DescribeDBSnapshots request. 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.
*
* @param marker An optional pagination token provided by a previous
* DescribeDBSnapshots request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBSnapshotsRequest withMarker(String marker) {
this.marker = marker;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDBInstanceIdentifier() != null) sb.append("DBInstanceIdentifier: " + getDBInstanceIdentifier() + ",");
if (getDBSnapshotIdentifier() != null) sb.append("DBSnapshotIdentifier: " + getDBSnapshotIdentifier() + ",");
if (getSnapshotType() != null) sb.append("SnapshotType: " + getSnapshotType() + ",");
if (getFilters() != null) sb.append("Filters: " + getFilters() + ",");
if (getMaxRecords() != null) sb.append("MaxRecords: " + getMaxRecords() + ",");
if (getMarker() != null) sb.append("Marker: " + getMarker() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().hashCode());
hashCode = prime * hashCode + ((getDBSnapshotIdentifier() == null) ? 0 : getDBSnapshotIdentifier().hashCode());
hashCode = prime * hashCode + ((getSnapshotType() == null) ? 0 : getSnapshotType().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeDBSnapshotsRequest == false) return false;
DescribeDBSnapshotsRequest other = (DescribeDBSnapshotsRequest)obj;
if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null) return false;
if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == false) return false;
if (other.getDBSnapshotIdentifier() == null ^ this.getDBSnapshotIdentifier() == null) return false;
if (other.getDBSnapshotIdentifier() != null && other.getDBSnapshotIdentifier().equals(this.getDBSnapshotIdentifier()) == false) return false;
if (other.getSnapshotType() == null ^ this.getSnapshotType() == null) return false;
if (other.getSnapshotType() != null && other.getSnapshotType().equals(this.getSnapshotType()) == false) return false;
if (other.getFilters() == null ^ this.getFilters() == null) return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null) return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false) return false;
if (other.getMarker() == null ^ this.getMarker() == null) return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false) return false;
return true;
}
}