DescribeReservedCacheNodesOfferingsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest

All Implemented Interfaces:

Serializable
```
public class DescribeReservedCacheNodesOfferingsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DescribeReservedCacheNodesOfferings operation.
The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.

See Also:
AmazonElastiCache.describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeReservedCacheNodesOfferingsRequest()

Constructors
Constructor and Description
`DescribeReservedCacheNodesOfferingsRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getCacheNodeType()` The cache node type filter value.
`String`	`getDuration()` 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`	`getReservedCacheNodesOfferingId()` The offering identifier filter value.
`int`	`hashCode()`
`void`	`setCacheNodeType(String cacheNodeType)` The cache node type filter value.
`void`	`setDuration(String duration)` 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`	`setReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)` The offering identifier filter value.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeReservedCacheNodesOfferingsRequest`	`withCacheNodeType(String cacheNodeType)` The cache node type filter value.
`DescribeReservedCacheNodesOfferingsRequest`	`withDuration(String duration)` Duration filter value, specified in years or seconds.
`DescribeReservedCacheNodesOfferingsRequest`	`withMarker(String marker)` An optional marker returned from a prior request.
`DescribeReservedCacheNodesOfferingsRequest`	`withMaxRecords(Integer maxRecords)` The maximum number of records to include in the response.
`DescribeReservedCacheNodesOfferingsRequest`	`withOfferingType(String offeringType)` The offering type filter value.
`DescribeReservedCacheNodesOfferingsRequest`	`withProductDescription(String productDescription)` The product description filter value.
`DescribeReservedCacheNodesOfferingsRequest`	`withReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)` The offering identifier filter value.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeReservedCacheNodesOfferingsRequest
```
public DescribeReservedCacheNodesOfferingsRequest()
```
- Method Detail
  - getReservedCacheNodesOfferingId
```
public String getReservedCacheNodesOfferingId()
```
    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:
    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
  - setReservedCacheNodesOfferingId
```
public void setReservedCacheNodesOfferingId(String 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
    
    Parameters:
    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
  - withReservedCacheNodesOfferingId
```
public DescribeReservedCacheNodesOfferingsRequest withReservedCacheNodesOfferingId(String 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.
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - getCacheNodeType
```
public String getCacheNodeType()
```
    The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
    
    Returns:
    The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
  - setCacheNodeType
```
public void setCacheNodeType(String cacheNodeType)
```
    The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
    
    Parameters:
    cacheNodeType - The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
  - withCacheNodeType
```
public DescribeReservedCacheNodesOfferingsRequest withCacheNodeType(String cacheNodeType)
```
    The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    cacheNodeType - The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDuration
```
public String getDuration()
```
    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:
    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
  - setDuration
```
public void setDuration(String 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
    
    Parameters:
    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
  - withDuration
```
public DescribeReservedCacheNodesOfferingsRequest withDuration(String 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.
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - getProductDescription
```
public String getProductDescription()
```
    The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
    
    Returns:
    The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
  - setProductDescription
```
public void setProductDescription(String productDescription)
```
    The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
    
    Parameters:
    productDescription - The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
  - withProductDescription
```
public DescribeReservedCacheNodesOfferingsRequest withProductDescription(String 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.
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - 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"
  - 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"
  - withOfferingType
```
public DescribeReservedCacheNodesOfferingsRequest 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"
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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 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 DescribeReservedCacheNodesOfferingsRequest 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - getMarker
```
public String getMarker()
```
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - setMarker
```
public void setMarker(String marker)
```
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - withMarker
```
public DescribeReservedCacheNodesOfferingsRequest withMarker(String marker)
```
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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.
    
    Parameters:
    marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 updated 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 class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DescribeReservedCacheNodesOfferingsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeReservedCacheNodesOfferingsRequest

Method Detail

getReservedCacheNodesOfferingId

setReservedCacheNodesOfferingId

withReservedCacheNodesOfferingId

getCacheNodeType

setCacheNodeType

withCacheNodeType

getDuration

setDuration

withDuration

getProductDescription

setProductDescription

withProductDescription

getOfferingType

setOfferingType

withOfferingType

getMaxRecords

setMaxRecords

withMaxRecords

getMarker

setMarker

withMarker

toString

hashCode

equals