com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache Show documentation
/*
* 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;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.elasticache.AmazonElastiCache#describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest) DescribeReservedCacheNodesOfferings operation}.
*
* The DescribeReservedCacheNodesOfferings action lists available
* reserved cache node offerings.
*
*
* @see com.amazonaws.services.elasticache.AmazonElastiCache#describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)
*/
public class DescribeReservedCacheNodesOfferingsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* The offering identifier filter value. Use this parameter to show only
* the available offering that matches the specified reservation
* identifier. Example:
* 438012d3-4052-4cc7-b2e3-8d3372e0e706
*/
private String reservedCacheNodesOfferingId;
/**
* The cache node type filter value. Use this parameter to show only the
* available offerings matching the specified cache node type.
Valid
* node types are as follows:
- General purpose:
- Current
* generation:
cache.t2.micro, cache.t2.small,
* cache.t2.medium, cache.m3.medium,
* cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge - Previous generation:
*
cache.t1.micro, cache.m1.small,
* cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
- Compute optimized:
*
cache.c1.xlarge - Memory optimized
* - Current generation:
cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
* - Previous generation:
cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
Notes:
- All t2 instances are
* created in an Amazon Virtual Private Cloud (VPC).
- Redis
* backup/restore is not supported for t2 instances.
- Redis
* Append-only files (AOF) functionality is not supported for t1 or t2
* instances.
For a complete listing of cache node types
* and specifications, see Amazon ElastiCache
* Product Features and Details and Cache
* Node Type-Specific Parameters for Memcached or Cache
* Node Type-Specific Parameters for Redis.
*/
private String cacheNodeType;
/**
* Duration filter value, specified in years or seconds. Use this
* parameter to show only reservations for a given duration.
Valid
* Values: 1 | 3 | 31536000 | 94608000
*/
private String duration;
/**
* The product description filter value. Use this parameter to show only
* the available offerings matching the specified product description.
*/
private String productDescription;
/**
* The offering type filter value. Use this parameter to show only the
* available offerings matching the specified offering type.
Valid
* Values: "Light Utilization"|"Medium Utilization"|"Heavy
* Utilization"
*/
private String offeringType;
/**
* 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;
/**
* The offering identifier filter value. Use this parameter to show only
* the available offering that matches the specified reservation
* identifier.
Example:
* 438012d3-4052-4cc7-b2e3-8d3372e0e706
*
* @return The offering identifier filter value. Use this parameter to show only
* the available offering that matches the specified reservation
* identifier.
Example:
* 438012d3-4052-4cc7-b2e3-8d3372e0e706
*/
public String getReservedCacheNodesOfferingId() {
return reservedCacheNodesOfferingId;
}
/**
* The offering identifier filter value. Use this parameter to show only
* the available offering that matches the specified reservation
* identifier.
Example:
* 438012d3-4052-4cc7-b2e3-8d3372e0e706
*
* @param reservedCacheNodesOfferingId The offering identifier filter value. Use this parameter to show only
* the available offering that matches the specified reservation
* identifier.
Example:
* 438012d3-4052-4cc7-b2e3-8d3372e0e706
*/
public void setReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) {
this.reservedCacheNodesOfferingId = reservedCacheNodesOfferingId;
}
/**
* The offering identifier filter value. Use this parameter to show only
* the available offering that matches the specified reservation
* identifier.
Example:
* 438012d3-4052-4cc7-b2e3-8d3372e0e706
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param reservedCacheNodesOfferingId The offering identifier filter value. Use this parameter to show only
* the available offering that matches the specified reservation
* identifier.
Example:
* 438012d3-4052-4cc7-b2e3-8d3372e0e706
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedCacheNodesOfferingsRequest withReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) {
this.reservedCacheNodesOfferingId = reservedCacheNodesOfferingId;
return this;
}
/**
* The cache node type filter value. Use this parameter to show only the
* available offerings matching the specified cache node type.
Valid
* node types are as follows:
- General purpose:
- Current
* generation:
cache.t2.micro, cache.t2.small,
* cache.t2.medium, cache.m3.medium,
* cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge - Previous generation:
*
cache.t1.micro, cache.m1.small,
* cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
- Compute optimized:
*
cache.c1.xlarge - Memory optimized
* - Current generation:
cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
* - Previous generation:
cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
Notes:
- All t2 instances are
* created in an Amazon Virtual Private Cloud (VPC).
- Redis
* backup/restore is not supported for t2 instances.
- Redis
* Append-only files (AOF) functionality is not supported for t1 or t2
* instances.
For a complete listing of cache node types
* and specifications, see Amazon ElastiCache
* Product Features and Details and Cache
* Node Type-Specific Parameters for Memcached or Cache
* Node Type-Specific Parameters for Redis.
*
* @return The cache node type filter value. Use this parameter to show only the
* available offerings matching the specified cache node type.
Valid
* node types are as follows:
- General purpose:
- Current
* generation:
cache.t2.micro, cache.t2.small,
* cache.t2.medium, cache.m3.medium,
* cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge - Previous generation:
*
cache.t1.micro, cache.m1.small,
* cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
- Compute optimized:
*
cache.c1.xlarge - Memory optimized
* - Current generation:
cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
* - Previous generation:
cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
Notes:
- All t2 instances are
* created in an Amazon Virtual Private Cloud (VPC).
- Redis
* backup/restore is not supported for t2 instances.
- Redis
* Append-only files (AOF) functionality is not supported for t1 or t2
* instances.
For a complete listing of cache node types
* and specifications, see Amazon ElastiCache
* Product Features and Details and Cache
* Node Type-Specific Parameters for Memcached or Cache
* Node Type-Specific Parameters for Redis.
*/
public String getCacheNodeType() {
return cacheNodeType;
}
/**
* The cache node type filter value. Use this parameter to show only the
* available offerings matching the specified cache node type.
Valid
* node types are as follows:
- General purpose:
- Current
* generation:
cache.t2.micro, cache.t2.small,
* cache.t2.medium, cache.m3.medium,
* cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge - Previous generation:
*
cache.t1.micro, cache.m1.small,
* cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
- Compute optimized:
*
cache.c1.xlarge - Memory optimized
* - Current generation:
cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
* - Previous generation:
cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
Notes:
- All t2 instances are
* created in an Amazon Virtual Private Cloud (VPC).
- Redis
* backup/restore is not supported for t2 instances.
- Redis
* Append-only files (AOF) functionality is not supported for t1 or t2
* instances.
For a complete listing of cache node types
* and specifications, see Amazon ElastiCache
* Product Features and Details and Cache
* Node Type-Specific Parameters for Memcached or Cache
* Node Type-Specific Parameters for Redis.
*
* @param cacheNodeType The cache node type filter value. Use this parameter to show only the
* available offerings matching the specified cache node type.
Valid
* node types are as follows:
- General purpose:
- Current
* generation:
cache.t2.micro, cache.t2.small,
* cache.t2.medium, cache.m3.medium,
* cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge - Previous generation:
*
cache.t1.micro, cache.m1.small,
* cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
- Compute optimized:
*
cache.c1.xlarge - Memory optimized
* - Current generation:
cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
* - Previous generation:
cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
Notes:
- All t2 instances are
* created in an Amazon Virtual Private Cloud (VPC).
- Redis
* backup/restore is not supported for t2 instances.
- Redis
* Append-only files (AOF) functionality is not supported for t1 or t2
* instances.
For a complete listing of cache node types
* and specifications, see Amazon ElastiCache
* Product Features and Details and Cache
* Node Type-Specific Parameters for Memcached or Cache
* Node Type-Specific Parameters for Redis.
*/
public void setCacheNodeType(String cacheNodeType) {
this.cacheNodeType = cacheNodeType;
}
/**
* The cache node type filter value. Use this parameter to show only the
* available offerings matching the specified cache node type.
Valid
* node types are as follows:
- General purpose:
- Current
* generation:
cache.t2.micro, cache.t2.small,
* cache.t2.medium, cache.m3.medium,
* cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge - Previous generation:
*
cache.t1.micro, cache.m1.small,
* cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
- Compute optimized:
*
cache.c1.xlarge - Memory optimized
* - Current generation:
cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
* - Previous generation:
cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
Notes:
- All t2 instances are
* created in an Amazon Virtual Private Cloud (VPC).
- Redis
* backup/restore is not supported for t2 instances.
- Redis
* Append-only files (AOF) functionality is not supported for t1 or t2
* instances.
For a complete listing of cache node types
* and specifications, see Amazon ElastiCache
* Product Features and Details and Cache
* Node Type-Specific Parameters for Memcached or Cache
* Node Type-Specific Parameters for Redis.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param cacheNodeType The cache node type filter value. Use this parameter to show only the
* available offerings matching the specified cache node type.
Valid
* node types are as follows:
- General purpose:
- Current
* generation:
cache.t2.micro, cache.t2.small,
* cache.t2.medium, cache.m3.medium,
* cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge - Previous generation:
*
cache.t1.micro, cache.m1.small,
* cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
- Compute optimized:
*
cache.c1.xlarge - Memory optimized
* - Current generation:
cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
* - Previous generation:
cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
Notes:
- All t2 instances are
* created in an Amazon Virtual Private Cloud (VPC).
- Redis
* backup/restore is not supported for t2 instances.
- Redis
* Append-only files (AOF) functionality is not supported for t1 or t2
* instances.
For a complete listing of cache node types
* and specifications, see Amazon ElastiCache
* Product Features and Details and Cache
* Node Type-Specific Parameters for Memcached or Cache
* Node Type-Specific Parameters for Redis.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedCacheNodesOfferingsRequest withCacheNodeType(String cacheNodeType) {
this.cacheNodeType = cacheNodeType;
return this;
}
/**
* Duration filter value, specified in years or seconds. Use this
* parameter to show only reservations for a given duration.
Valid
* Values: 1 | 3 | 31536000 | 94608000
*
* @return Duration filter value, specified in years or seconds. Use this
* parameter to show only reservations for a given duration.
Valid
* Values: 1 | 3 | 31536000 | 94608000
*/
public String getDuration() {
return duration;
}
/**
* Duration filter value, specified in years or seconds. Use this
* parameter to show only reservations for a given duration.
Valid
* Values: 1 | 3 | 31536000 | 94608000
*
* @param duration Duration filter value, specified in years or seconds. Use this
* parameter to show only reservations for a given duration.
Valid
* Values: 1 | 3 | 31536000 | 94608000
*/
public void setDuration(String duration) {
this.duration = duration;
}
/**
* Duration filter value, specified in years or seconds. Use this
* parameter to show only reservations for a given duration.
Valid
* Values: 1 | 3 | 31536000 | 94608000
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param duration Duration filter value, specified in years or seconds. Use this
* parameter to show only reservations for a given duration.
Valid
* Values: 1 | 3 | 31536000 | 94608000
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedCacheNodesOfferingsRequest withDuration(String duration) {
this.duration = duration;
return this;
}
/**
* The product description filter value. Use this parameter to show only
* the available offerings matching the specified product description.
*
* @return The product description filter value. Use this parameter to show only
* the available offerings matching the specified product description.
*/
public String getProductDescription() {
return productDescription;
}
/**
* The product description filter value. Use this parameter to show only
* the available offerings matching the specified product description.
*
* @param productDescription The product description filter value. Use this parameter to show only
* the available offerings matching the specified product description.
*/
public void setProductDescription(String productDescription) {
this.productDescription = productDescription;
}
/**
* The product description filter value. Use this parameter to show only
* the available offerings matching the specified product description.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param productDescription The product description filter value. Use this parameter to show only
* the available offerings matching the specified product description.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedCacheNodesOfferingsRequest withProductDescription(String productDescription) {
this.productDescription = productDescription;
return this;
}
/**
* The offering type filter value. Use this parameter to show only the
* available offerings matching the specified offering type.
Valid
* Values: "Light Utilization"|"Medium Utilization"|"Heavy
* Utilization"
*
* @return The offering type filter value. Use this parameter to show only the
* available offerings matching the specified offering type.
Valid
* Values: "Light Utilization"|"Medium Utilization"|"Heavy
* Utilization"
*/
public String getOfferingType() {
return offeringType;
}
/**
* The offering type filter value. Use this parameter to show only the
* available offerings matching the specified offering type.
Valid
* Values: "Light Utilization"|"Medium Utilization"|"Heavy
* Utilization"
*
* @param offeringType The offering type filter value. Use this parameter to show only the
* available offerings matching the specified offering type.
Valid
* Values: "Light Utilization"|"Medium Utilization"|"Heavy
* Utilization"
*/
public void setOfferingType(String offeringType) {
this.offeringType = offeringType;
}
/**
* The offering type filter value. Use this parameter to show only the
* available offerings matching the specified offering type.
Valid
* Values: "Light Utilization"|"Medium Utilization"|"Heavy
* Utilization"
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param offeringType The offering type filter value. Use this parameter to show only the
* available offerings matching the specified offering type.
Valid
* Values: "Light Utilization"|"Medium Utilization"|"Heavy
* Utilization"
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedCacheNodesOfferingsRequest withOfferingType(String offeringType) {
this.offeringType = offeringType;
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.
*
* @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.
*/
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
* 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
* 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
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedCacheNodesOfferingsRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = 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.
*
* @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.
*/
public String getMarker() {
return 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.
*
* @param 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 = 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReservedCacheNodesOfferingsRequest 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 (getReservedCacheNodesOfferingId() != null) sb.append("ReservedCacheNodesOfferingId: " + getReservedCacheNodesOfferingId() + ",");
if (getCacheNodeType() != null) sb.append("CacheNodeType: " + getCacheNodeType() + ",");
if (getDuration() != null) sb.append("Duration: " + getDuration() + ",");
if (getProductDescription() != null) sb.append("ProductDescription: " + getProductDescription() + ",");
if (getOfferingType() != null) sb.append("OfferingType: " + getOfferingType() + ",");
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 + ((getReservedCacheNodesOfferingId() == null) ? 0 : getReservedCacheNodesOfferingId().hashCode());
hashCode = prime * hashCode + ((getCacheNodeType() == null) ? 0 : getCacheNodeType().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 + ((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 DescribeReservedCacheNodesOfferingsRequest == false) return false;
DescribeReservedCacheNodesOfferingsRequest other = (DescribeReservedCacheNodesOfferingsRequest)obj;
if (other.getReservedCacheNodesOfferingId() == null ^ this.getReservedCacheNodesOfferingId() == null) return false;
if (other.getReservedCacheNodesOfferingId() != null && other.getReservedCacheNodesOfferingId().equals(this.getReservedCacheNodesOfferingId()) == false) return false;
if (other.getCacheNodeType() == null ^ this.getCacheNodeType() == null) return false;
if (other.getCacheNodeType() != null && other.getCacheNodeType().equals(this.getCacheNodeType()) == 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.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 DescribeReservedCacheNodesOfferingsRequest clone() {
return (DescribeReservedCacheNodesOfferingsRequest) super.clone();
}
}