com.amazonaws.services.elasticache.model

Class RebootCacheClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.RebootCacheClusterRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RebootCacheClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RebootCacheCluster operation.

The RebootCacheCluster action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cache cluster event is created.

See Also:

AmazonElastiCache.rebootCacheCluster(RebootCacheClusterRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RebootCacheClusterRequest() Default constructor for a new RebootCacheClusterRequest object.
RebootCacheClusterRequest(String cacheClusterId, List<String> cacheNodeIdsToReboot) Constructs a new RebootCacheClusterRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
RebootCacheClusterRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCacheClusterId() The cache cluster identifier.
List<String>	getCacheNodeIdsToReboot() A list of cache node IDs to reboot.
int	hashCode()
void	setCacheClusterId(String cacheClusterId) The cache cluster identifier.
void	setCacheNodeIdsToReboot(Collection<String> cacheNodeIdsToReboot) A list of cache node IDs to reboot.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RebootCacheClusterRequest	withCacheClusterId(String cacheClusterId) The cache cluster identifier.
RebootCacheClusterRequest	withCacheNodeIdsToReboot(Collection<String> cacheNodeIdsToReboot) A list of cache node IDs to reboot.
RebootCacheClusterRequest	withCacheNodeIdsToReboot(String... cacheNodeIdsToReboot) A list of cache node IDs to reboot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RebootCacheClusterRequest

public RebootCacheClusterRequest()

Default constructor for a new RebootCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

RebootCacheClusterRequest

public RebootCacheClusterRequest(String cacheClusterId,
                         List<String> cacheNodeIdsToReboot)

Constructs a new RebootCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

cacheClusterId - The cache cluster identifier. This parameter is stored as a lowercase string.

cacheNodeIdsToReboot - A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

Method Detail

getCacheClusterId

public String getCacheClusterId()

The cache cluster identifier. This parameter is stored as a lowercase string.

Returns:

The cache cluster identifier. This parameter is stored as a lowercase string.

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

The cache cluster identifier. This parameter is stored as a lowercase string.

Parameters:

cacheClusterId - The cache cluster identifier. This parameter is stored as a lowercase string.

withCacheClusterId

public RebootCacheClusterRequest withCacheClusterId(String cacheClusterId)

The cache cluster identifier. This parameter is stored as a lowercase string.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheClusterId - The cache cluster identifier. This parameter is stored as a lowercase string.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheNodeIdsToReboot

public List<String> getCacheNodeIdsToReboot()

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

Returns:

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

setCacheNodeIdsToReboot

public void setCacheNodeIdsToReboot(Collection<String> cacheNodeIdsToReboot)

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

Parameters:

cacheNodeIdsToReboot - A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

withCacheNodeIdsToReboot

public RebootCacheClusterRequest withCacheNodeIdsToReboot(String... cacheNodeIdsToReboot)

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

NOTE: This method appends the values to the existing list (if any). Use setCacheNodeIdsToReboot(java.util.Collection) or withCacheNodeIdsToReboot(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheNodeIdsToReboot - A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

withCacheNodeIdsToReboot

public RebootCacheClusterRequest withCacheNodeIdsToReboot(Collection<String> cacheNodeIdsToReboot)

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheNodeIdsToReboot - A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

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

clone

public RebootCacheClusterRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()