Class DescribeReservedCacheNodesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeReservedCacheNodesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a DescribeReservedCacheNodes action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeReservedCacheNodesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeReservedCacheNodesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getCacheNodeType()
The cache node type filter value.String
getDuration()
The duration filter value, specified in years or seconds.String
getMarker()
An optional marker returned from a prior request.Integer
getMaxRecords()
The maximum number of records to include in the response.String
getOfferingType()
The offering type filter value.String
getProductDescription()
The product description filter value.String
getReservedCacheNodeId()
The reserved cache node identifier filter value.String
getReservedCacheNodesOfferingId()
The offering identifier filter value.int
hashCode()
void
setCacheNodeType(String cacheNodeType)
The cache node type filter value.void
setDuration(String duration)
The duration filter value, specified in years or seconds.void
setMarker(String marker)
An optional marker returned from a prior request.void
setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.void
setOfferingType(String offeringType)
The offering type filter value.void
setProductDescription(String productDescription)
The product description filter value.void
setReservedCacheNodeId(String reservedCacheNodeId)
The reserved cache node identifier filter value.void
setReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)
The offering identifier filter value.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeReservedCacheNodesRequest
withCacheNodeType(String cacheNodeType)
The cache node type filter value.DescribeReservedCacheNodesRequest
withDuration(String duration)
The duration filter value, specified in years or seconds.DescribeReservedCacheNodesRequest
withMarker(String marker)
An optional marker returned from a prior request.DescribeReservedCacheNodesRequest
withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.DescribeReservedCacheNodesRequest
withOfferingType(String offeringType)
The offering type filter value.DescribeReservedCacheNodesRequest
withProductDescription(String productDescription)
The product description filter value.DescribeReservedCacheNodesRequest
withReservedCacheNodeId(String reservedCacheNodeId)
The reserved cache node identifier filter value.DescribeReservedCacheNodesRequest
withReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)
The offering identifier filter value.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setReservedCacheNodeId
public void setReservedCacheNodeId(String reservedCacheNodeId)
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
- Parameters:
reservedCacheNodeId
- The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
-
getReservedCacheNodeId
public String getReservedCacheNodeId()
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
- Returns:
- The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
-
withReservedCacheNodeId
public DescribeReservedCacheNodesRequest withReservedCacheNodeId(String reservedCacheNodeId)
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
- Parameters:
reservedCacheNodeId
- The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReservedCacheNodesOfferingId
public void setReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
- Parameters:
reservedCacheNodesOfferingId
- The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
-
getReservedCacheNodesOfferingId
public String getReservedCacheNodesOfferingId()
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
- Returns:
- The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
-
withReservedCacheNodesOfferingId
public DescribeReservedCacheNodesRequest withReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
- Parameters:
reservedCacheNodesOfferingId
- The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheNodeType
public void setCacheNodeType(String cacheNodeType)
The cache node type filter value. Use this parameter to show only those reservations 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
- Current generation:
- 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
- Current generation:
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.
- Parameters:
cacheNodeType
- The cache node type filter value. Use this parameter to show only those reservations 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
- Current generation:
- 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
- Current generation:
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.
- General purpose:
- General purpose:
-
getCacheNodeType
public String getCacheNodeType()
The cache node type filter value. Use this parameter to show only those reservations 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
- Current generation:
- 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
- Current generation:
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:
- The cache node type filter value. Use this parameter to show only
those reservations 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
- Current generation:
- 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
- Current generation:
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.
- General purpose:
- General purpose:
-
withCacheNodeType
public DescribeReservedCacheNodesRequest withCacheNodeType(String cacheNodeType)
The cache node type filter value. Use this parameter to show only those reservations 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
- Current generation:
- 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
- Current generation:
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.
- Parameters:
cacheNodeType
- The cache node type filter value. Use this parameter to show only those reservations 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
- Current generation:
- 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
- Current generation:
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.
- General purpose:
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- General purpose:
-
setDuration
public void setDuration(String duration)
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values:
1 | 3 | 31536000 | 94608000
- Parameters:
duration
- The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.Valid Values:
1 | 3 | 31536000 | 94608000
-
getDuration
public String getDuration()
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values:
1 | 3 | 31536000 | 94608000
- Returns:
- The duration filter value, specified in years or seconds. Use
this parameter to show only reservations for this duration.
Valid Values:
1 | 3 | 31536000 | 94608000
-
withDuration
public DescribeReservedCacheNodesRequest withDuration(String duration)
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values:
1 | 3 | 31536000 | 94608000
- Parameters:
duration
- The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.Valid Values:
1 | 3 | 31536000 | 94608000
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setProductDescription
public void setProductDescription(String productDescription)
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
- Parameters:
productDescription
- The product description filter value. Use this parameter to show only those reservations matching the specified product description.
-
getProductDescription
public String getProductDescription()
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
- Returns:
- The product description filter value. Use this parameter to show only those reservations matching the specified product description.
-
withProductDescription
public DescribeReservedCacheNodesRequest withProductDescription(String productDescription)
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
- Parameters:
productDescription
- The product description filter value. Use this parameter to show only those reservations matching the specified product description.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOfferingType
public void setOfferingType(String 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"
- Parameters:
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"
-
getOfferingType
public String getOfferingType()
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:
- 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"
-
withOfferingType
public DescribeReservedCacheNodesRequest withOfferingType(String 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"
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxRecords
public void setMaxRecords(Integer 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.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: minimum 20; maximum 100.
-
getMaxRecords
public Integer getMaxRecords()
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:
- 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.
-
withMaxRecords
public DescribeReservedCacheNodesRequest withMaxRecords(Integer 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.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: minimum 20; maximum 100.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
public void setMarker(String 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.
- 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.
-
getMarker
public String getMarker()
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.
-
withMarker
public DescribeReservedCacheNodesRequest withMarker(String 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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeReservedCacheNodesRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-