com.amazonaws.services.rds.model.DescribeDBClusterSnapshotsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2010-2016 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;
/**
*
*/
public class DescribeDBClusterSnapshotsRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* A DB cluster identifier to retrieve the list of DB cluster snapshots for.
* This parameter cannot be used in conjunction with the
* DBClusterSnapshotIdentifier parameter. 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 dBClusterIdentifier;
/**
*
* A specific DB cluster snapshot identifier to describe. This parameter
* cannot be used in conjunction with the DBClusterIdentifier
* parameter. 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 dBClusterSnapshotIdentifier;
/**
*
* The type of DB cluster snapshots that will be returned. Values can be
* automated or manual. If this parameter is not
* specified, the returned results will include all snapshot types.
*
*/
private String snapshotType;
/**
*
* This parameter is not currently supported.
*
*/
private com.amazonaws.internal.SdkInternalList 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 can be retrieved.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*/
private Integer maxRecords;
/**
*
* An optional pagination token provided by a previous
* DescribeDBClusterSnapshots request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
*/
private String marker;
/**
*
* A DB cluster identifier to retrieve the list of DB cluster snapshots for.
* This parameter cannot be used in conjunction with the
* DBClusterSnapshotIdentifier parameter. 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 dBClusterIdentifier
* A DB cluster identifier to retrieve the list of DB cluster
* snapshots for. This parameter cannot be used in conjunction with
* the DBClusterSnapshotIdentifier parameter. 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 setDBClusterIdentifier(String dBClusterIdentifier) {
this.dBClusterIdentifier = dBClusterIdentifier;
}
/**
*
* A DB cluster identifier to retrieve the list of DB cluster snapshots for.
* This parameter cannot be used in conjunction with the
* DBClusterSnapshotIdentifier parameter. 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 cluster identifier to retrieve the list of DB cluster
* snapshots for. This parameter cannot be used in conjunction with
* the DBClusterSnapshotIdentifier parameter. 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 getDBClusterIdentifier() {
return this.dBClusterIdentifier;
}
/**
*
* A DB cluster identifier to retrieve the list of DB cluster snapshots for.
* This parameter cannot be used in conjunction with the
* DBClusterSnapshotIdentifier parameter. 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 dBClusterIdentifier
* A DB cluster identifier to retrieve the list of DB cluster
* snapshots for. This parameter cannot be used in conjunction with
* the DBClusterSnapshotIdentifier parameter. 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 Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBClusterSnapshotsRequest withDBClusterIdentifier(
String dBClusterIdentifier) {
setDBClusterIdentifier(dBClusterIdentifier);
return this;
}
/**
*
* A specific DB cluster snapshot identifier to describe. This parameter
* cannot be used in conjunction with the DBClusterIdentifier
* parameter. 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 dBClusterSnapshotIdentifier
* A specific DB cluster snapshot identifier to describe. This
* parameter cannot be used in conjunction with the
* DBClusterIdentifier parameter. 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 setDBClusterSnapshotIdentifier(
String dBClusterSnapshotIdentifier) {
this.dBClusterSnapshotIdentifier = dBClusterSnapshotIdentifier;
}
/**
*
* A specific DB cluster snapshot identifier to describe. This parameter
* cannot be used in conjunction with the DBClusterIdentifier
* parameter. 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 cluster snapshot identifier to describe. This
* parameter cannot be used in conjunction with the
* DBClusterIdentifier parameter. 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 getDBClusterSnapshotIdentifier() {
return this.dBClusterSnapshotIdentifier;
}
/**
*
* A specific DB cluster snapshot identifier to describe. This parameter
* cannot be used in conjunction with the DBClusterIdentifier
* parameter. 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 dBClusterSnapshotIdentifier
* A specific DB cluster snapshot identifier to describe. This
* parameter cannot be used in conjunction with the
* DBClusterIdentifier parameter. 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 Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBClusterSnapshotsRequest withDBClusterSnapshotIdentifier(
String dBClusterSnapshotIdentifier) {
setDBClusterSnapshotIdentifier(dBClusterSnapshotIdentifier);
return this;
}
/**
*
* The type of DB cluster snapshots that will be returned. Values can be
* automated or manual. If this parameter is not
* specified, the returned results will include all snapshot types.
*
*
* @param snapshotType
* The type of DB cluster snapshots that will be returned. Values can
* be automated or manual. If this
* parameter is not specified, the returned results will include all
* snapshot types.
*/
public void setSnapshotType(String snapshotType) {
this.snapshotType = snapshotType;
}
/**
*
* The type of DB cluster snapshots that will be returned. Values can be
* automated or manual. If this parameter is not
* specified, the returned results will include all snapshot types.
*
*
* @return The type of DB cluster snapshots that will be returned. Values
* can be automated or manual. If this
* parameter is not specified, the returned results will include all
* snapshot types.
*/
public String getSnapshotType() {
return this.snapshotType;
}
/**
*
* The type of DB cluster snapshots that will be returned. Values can be
* automated or manual. If this parameter is not
* specified, the returned results will include all snapshot types.
*
*
* @param snapshotType
* The type of DB cluster snapshots that will be returned. Values can
* be automated or manual. If this
* parameter is not specified, the returned results will include all
* snapshot types.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBClusterSnapshotsRequest withSnapshotType(
String snapshotType) {
setSnapshotType(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.SdkInternalList();
}
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;
}
this.filters = new com.amazonaws.internal.SdkInternalList(
filters);
}
/**
*
* This parameter is not currently supported.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFilters(java.util.Collection)} or
* {@link #withFilters(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param filters
* This parameter is not currently supported.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBClusterSnapshotsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(
filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* This parameter is not currently supported.
*
*
* @param filters
* This parameter is not currently supported.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBClusterSnapshotsRequest withFilters(
java.util.Collection filters) {
setFilters(filters);
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 can 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 can 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 can 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 can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
public Integer getMaxRecords() {
return this.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 can 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 can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBClusterSnapshotsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* An optional pagination token provided by a previous
* DescribeDBClusterSnapshots 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
* DescribeDBClusterSnapshots 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
* DescribeDBClusterSnapshots 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
* DescribeDBClusterSnapshots 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 this.marker;
}
/**
*
* An optional pagination token provided by a previous
* DescribeDBClusterSnapshots 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
* DescribeDBClusterSnapshots request. If this parameter
* is specified, the response includes only records beyond the
* marker, up to the value specified by MaxRecords.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBClusterSnapshotsRequest withMarker(String marker) {
setMarker(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 (getDBClusterIdentifier() != null)
sb.append("DBClusterIdentifier: " + getDBClusterIdentifier() + ",");
if (getDBClusterSnapshotIdentifier() != null)
sb.append("DBClusterSnapshotIdentifier: "
+ getDBClusterSnapshotIdentifier() + ",");
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 boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDBClusterSnapshotsRequest == false)
return false;
DescribeDBClusterSnapshotsRequest other = (DescribeDBClusterSnapshotsRequest) obj;
if (other.getDBClusterIdentifier() == null
^ this.getDBClusterIdentifier() == null)
return false;
if (other.getDBClusterIdentifier() != null
&& other.getDBClusterIdentifier().equals(
this.getDBClusterIdentifier()) == false)
return false;
if (other.getDBClusterSnapshotIdentifier() == null
^ this.getDBClusterSnapshotIdentifier() == null)
return false;
if (other.getDBClusterSnapshotIdentifier() != null
&& other.getDBClusterSnapshotIdentifier().equals(
this.getDBClusterSnapshotIdentifier()) == 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;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getDBClusterIdentifier() == null) ? 0
: getDBClusterIdentifier().hashCode());
hashCode = prime
* hashCode
+ ((getDBClusterSnapshotIdentifier() == null) ? 0
: getDBClusterSnapshotIdentifier().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 DescribeDBClusterSnapshotsRequest clone() {
return (DescribeDBClusterSnapshotsRequest) super.clone();
}
}