/* * Copyright 2018-2023 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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeReservedDBInstancesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that * matches the specified reservation ID. *
*/ private String reservedDBInstanceId; /** ** The offering identifier filter value. Specify this parameter to show only purchased reservations matching the * specified offering identifier. *
*/ private String reservedDBInstancesOfferingId; /** ** The DB instance class filter value. Specify this parameter to show only those reservations matching the specified * DB instances class. *
*/ private String dBInstanceClass; /** ** The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for * this duration. *
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
* The product description filter value. Specify this parameter to show only those reservations matching the * specified product description. *
*/ private String productDescription; /** ** The offering type filter value. Specify this parameter to show only the available offerings matching the * specified offering type. *
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*
* A value that indicates whether to show only those reservations that support Multi-AZ. *
*/ private Boolean multiAZ; /** ** The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified * lease ID. *
** Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. *
** This parameter isn't currently supported. *
*/ private com.amazonaws.internal.SdkInternalList
* The maximum number of records to include in the response. If more than the MaxRecords
value is
* available, a pagination token called a marker is included in the response so you can retrieve the remaining
* results.
*
* Default: 100 *
** Constraints: Minimum 20, maximum 100. *
*/ private Integer maxRecords; /** *
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords
.
*
* The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that * matches the specified reservation ID. *
* * @param reservedDBInstanceId * The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that * matches the specified reservation ID. */ public void setReservedDBInstanceId(String reservedDBInstanceId) { this.reservedDBInstanceId = reservedDBInstanceId; } /** ** The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that * matches the specified reservation ID. *
* * @return The reserved DB instance identifier filter value. Specify this parameter to show only the reservation * that matches the specified reservation ID. */ public String getReservedDBInstanceId() { return this.reservedDBInstanceId; } /** ** The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that * matches the specified reservation ID. *
* * @param reservedDBInstanceId * The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that * matches the specified reservation ID. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withReservedDBInstanceId(String reservedDBInstanceId) { setReservedDBInstanceId(reservedDBInstanceId); return this; } /** ** The offering identifier filter value. Specify this parameter to show only purchased reservations matching the * specified offering identifier. *
* * @param reservedDBInstancesOfferingId * The offering identifier filter value. Specify this parameter to show only purchased reservations matching * the specified offering identifier. */ public void setReservedDBInstancesOfferingId(String reservedDBInstancesOfferingId) { this.reservedDBInstancesOfferingId = reservedDBInstancesOfferingId; } /** ** The offering identifier filter value. Specify this parameter to show only purchased reservations matching the * specified offering identifier. *
* * @return The offering identifier filter value. Specify this parameter to show only purchased reservations matching * the specified offering identifier. */ public String getReservedDBInstancesOfferingId() { return this.reservedDBInstancesOfferingId; } /** ** The offering identifier filter value. Specify this parameter to show only purchased reservations matching the * specified offering identifier. *
* * @param reservedDBInstancesOfferingId * The offering identifier filter value. Specify this parameter to show only purchased reservations matching * the specified offering identifier. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withReservedDBInstancesOfferingId(String reservedDBInstancesOfferingId) { setReservedDBInstancesOfferingId(reservedDBInstancesOfferingId); return this; } /** ** The DB instance class filter value. Specify this parameter to show only those reservations matching the specified * DB instances class. *
* * @param dBInstanceClass * The DB instance class filter value. Specify this parameter to show only those reservations matching the * specified DB instances class. */ public void setDBInstanceClass(String dBInstanceClass) { this.dBInstanceClass = dBInstanceClass; } /** ** The DB instance class filter value. Specify this parameter to show only those reservations matching the specified * DB instances class. *
* * @return The DB instance class filter value. Specify this parameter to show only those reservations matching the * specified DB instances class. */ public String getDBInstanceClass() { return this.dBInstanceClass; } /** ** The DB instance class filter value. Specify this parameter to show only those reservations matching the specified * DB instances class. *
* * @param dBInstanceClass * The DB instance class filter value. Specify this parameter to show only those reservations matching the * specified DB instances class. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withDBInstanceClass(String dBInstanceClass) { setDBInstanceClass(dBInstanceClass); return this; } /** ** The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for * this duration. *
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*/
public void setDuration(String duration) {
this.duration = duration;
}
/**
*
* The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for * this duration. *
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*/
public String getDuration() {
return this.duration;
}
/**
*
* The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for * this duration. *
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
* Valid Values: 1 | 3 | 31536000 | 94608000
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedDBInstancesRequest withDuration(String duration) {
setDuration(duration);
return this;
}
/**
*
* The product description filter value. Specify this parameter to show only those reservations matching the * specified product description. *
* * @param productDescription * The product description filter value. Specify this parameter to show only those reservations matching the * specified product description. */ public void setProductDescription(String productDescription) { this.productDescription = productDescription; } /** ** The product description filter value. Specify this parameter to show only those reservations matching the * specified product description. *
* * @return The product description filter value. Specify this parameter to show only those reservations matching the * specified product description. */ public String getProductDescription() { return this.productDescription; } /** ** The product description filter value. Specify this parameter to show only those reservations matching the * specified product description. *
* * @param productDescription * The product description filter value. Specify this parameter to show only those reservations matching the * specified product description. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withProductDescription(String productDescription) { setProductDescription(productDescription); return this; } /** ** The offering type filter value. Specify this parameter to show only the available offerings matching the * specified offering type. *
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*/
public void setOfferingType(String offeringType) {
this.offeringType = offeringType;
}
/**
*
* The offering type filter value. Specify this parameter to show only the available offerings matching the * specified offering type. *
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*/
public String getOfferingType() {
return this.offeringType;
}
/**
*
* The offering type filter value. Specify this parameter to show only the available offerings matching the * specified offering type. *
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedDBInstancesRequest withOfferingType(String offeringType) {
setOfferingType(offeringType);
return this;
}
/**
*
* A value that indicates whether to show only those reservations that support Multi-AZ. *
* * @param multiAZ * A value that indicates whether to show only those reservations that support Multi-AZ. */ public void setMultiAZ(Boolean multiAZ) { this.multiAZ = multiAZ; } /** ** A value that indicates whether to show only those reservations that support Multi-AZ. *
* * @return A value that indicates whether to show only those reservations that support Multi-AZ. */ public Boolean getMultiAZ() { return this.multiAZ; } /** ** A value that indicates whether to show only those reservations that support Multi-AZ. *
* * @param multiAZ * A value that indicates whether to show only those reservations that support Multi-AZ. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withMultiAZ(Boolean multiAZ) { setMultiAZ(multiAZ); return this; } /** ** A value that indicates whether to show only those reservations that support Multi-AZ. *
* * @return A value that indicates whether to show only those reservations that support Multi-AZ. */ public Boolean isMultiAZ() { return this.multiAZ; } /** ** The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified * lease ID. *
** Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. *
** Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. *
*/ public void setLeaseId(String leaseId) { this.leaseId = leaseId; } /** ** The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified * lease ID. *
** Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. *
** Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. *
*/ public String getLeaseId() { return this.leaseId; } /** ** The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified * lease ID. *
** Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. *
** Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. *
* @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withLeaseId(String leaseId) { setLeaseId(leaseId); return this; } /** ** This parameter isn't currently supported. *
* * @return This parameter isn't currently supported. */ public java.util.List* This parameter isn't currently supported. *
* * @param filters * This parameter isn't currently supported. */ public void setFilters(java.util.Collection* This parameter isn't 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 isn't currently supported. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withFilters(Filter... filters) { if (this.filters == null) { setFilters(new com.amazonaws.internal.SdkInternalList* This parameter isn't currently supported. *
* * @param filters * This parameter isn't currently supported. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withFilters(java.util.Collection
* The maximum number of records to include in the response. If more than the MaxRecords
value is
* available, a pagination token called a marker is included in the response so you can retrieve the remaining
* results.
*
* Default: 100 *
** Constraints: Minimum 20, maximum 100. *
* * @param maxRecords * The maximum number of records to include in the response. If more than theMaxRecords
value
* is available, a pagination token called a marker is included in the response so you can retrieve the
* remaining results.
* * 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 than the MaxRecords
value is
* available, a pagination token called a marker is included in the response so you can retrieve the remaining
* results.
*
* Default: 100 *
** Constraints: Minimum 20, maximum 100. *
* * @return The maximum number of records to include in the response. If more than theMaxRecords
value
* is available, a pagination token called a marker is included in the response so you can retrieve the
* remaining results.
* * 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 than the MaxRecords
value is
* available, a pagination token called a marker is included in the response so you can retrieve the remaining
* results.
*
* Default: 100 *
** Constraints: Minimum 20, maximum 100. *
* * @param maxRecords * The maximum number of records to include in the response. If more than theMaxRecords
value
* is available, a pagination token called a marker is included in the response so you can retrieve the
* remaining results.
* * Default: 100 *
** Constraints: Minimum 20, maximum 100. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeReservedDBInstancesRequest withMaxRecords(Integer maxRecords) { setMaxRecords(maxRecords); return this; } /** *
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords
.
*
MaxRecords
.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords
.
*
MaxRecords
.
*/
public String getMarker() {
return this.marker;
}
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords
.
*
MaxRecords
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedDBInstancesRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getReservedDBInstanceId() != null)
sb.append("ReservedDBInstanceId: ").append(getReservedDBInstanceId()).append(",");
if (getReservedDBInstancesOfferingId() != null)
sb.append("ReservedDBInstancesOfferingId: ").append(getReservedDBInstancesOfferingId()).append(",");
if (getDBInstanceClass() != null)
sb.append("DBInstanceClass: ").append(getDBInstanceClass()).append(",");
if (getDuration() != null)
sb.append("Duration: ").append(getDuration()).append(",");
if (getProductDescription() != null)
sb.append("ProductDescription: ").append(getProductDescription()).append(",");
if (getOfferingType() != null)
sb.append("OfferingType: ").append(getOfferingType()).append(",");
if (getMultiAZ() != null)
sb.append("MultiAZ: ").append(getMultiAZ()).append(",");
if (getLeaseId() != null)
sb.append("LeaseId: ").append(getLeaseId()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(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 DescribeReservedDBInstancesRequest == false)
return false;
DescribeReservedDBInstancesRequest other = (DescribeReservedDBInstancesRequest) obj;
if (other.getReservedDBInstanceId() == null ^ this.getReservedDBInstanceId() == null)
return false;
if (other.getReservedDBInstanceId() != null && other.getReservedDBInstanceId().equals(this.getReservedDBInstanceId()) == false)
return false;
if (other.getReservedDBInstancesOfferingId() == null ^ this.getReservedDBInstancesOfferingId() == null)
return false;
if (other.getReservedDBInstancesOfferingId() != null
&& other.getReservedDBInstancesOfferingId().equals(this.getReservedDBInstancesOfferingId()) == false)
return false;
if (other.getDBInstanceClass() == null ^ this.getDBInstanceClass() == null)
return false;
if (other.getDBInstanceClass() != null && other.getDBInstanceClass().equals(this.getDBInstanceClass()) == false)
return false;
if (other.getDuration() == null ^ this.getDuration() == null)
return false;
if (other.getDuration() != null && other.getDuration().equals(this.getDuration()) == false)
return false;
if (other.getProductDescription() == null ^ this.getProductDescription() == null)
return false;
if (other.getProductDescription() != null && other.getProductDescription().equals(this.getProductDescription()) == false)
return false;
if (other.getOfferingType() == null ^ this.getOfferingType() == null)
return false;
if (other.getOfferingType() != null && other.getOfferingType().equals(this.getOfferingType()) == false)
return false;
if (other.getMultiAZ() == null ^ this.getMultiAZ() == null)
return false;
if (other.getMultiAZ() != null && other.getMultiAZ().equals(this.getMultiAZ()) == false)
return false;
if (other.getLeaseId() == null ^ this.getLeaseId() == null)
return false;
if (other.getLeaseId() != null && other.getLeaseId().equals(this.getLeaseId()) == 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 + ((getReservedDBInstanceId() == null) ? 0 : getReservedDBInstanceId().hashCode());
hashCode = prime * hashCode + ((getReservedDBInstancesOfferingId() == null) ? 0 : getReservedDBInstancesOfferingId().hashCode());
hashCode = prime * hashCode + ((getDBInstanceClass() == null) ? 0 : getDBInstanceClass().hashCode());
hashCode = prime * hashCode + ((getDuration() == null) ? 0 : getDuration().hashCode());
hashCode = prime * hashCode + ((getProductDescription() == null) ? 0 : getProductDescription().hashCode());
hashCode = prime * hashCode + ((getOfferingType() == null) ? 0 : getOfferingType().hashCode());
hashCode = prime * hashCode + ((getMultiAZ() == null) ? 0 : getMultiAZ().hashCode());
hashCode = prime * hashCode + ((getLeaseId() == null) ? 0 : getLeaseId().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 DescribeReservedDBInstancesRequest clone() {
return (DescribeReservedDBInstancesRequest) super.clone();
}
}