com.amazonaws.services.storagegateway.model

Class UpdateSnapshotScheduleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.UpdateSnapshotScheduleRequest

All Implemented Interfaces:

Serializable

public class UpdateSnapshotScheduleRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateSnapshotSchedule operation.

This operation updates a snapshot schedule configured for a gateway volume.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the shapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

See Also:

AWSStorageGateway.updateSnapshotSchedule(UpdateSnapshotScheduleRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateSnapshotScheduleRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() Optional description of the snapshot that overwrites the existing description.
Integer	getRecurrenceInHours() Frequency of snapshots.
Integer	getStartAt() The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23).
String	getVolumeARN() The Amazon Resource Name (ARN) of the volume.
int	hashCode()
void	setDescription(String description) Optional description of the snapshot that overwrites the existing description.
void	setRecurrenceInHours(Integer recurrenceInHours) Frequency of snapshots.
void	setStartAt(Integer startAt) The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23).
void	setVolumeARN(String volumeARN) The Amazon Resource Name (ARN) of the volume.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateSnapshotScheduleRequest	withDescription(String description) Optional description of the snapshot that overwrites the existing description.
UpdateSnapshotScheduleRequest	withRecurrenceInHours(Integer recurrenceInHours) Frequency of snapshots.
UpdateSnapshotScheduleRequest	withStartAt(Integer startAt) The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23).
UpdateSnapshotScheduleRequest	withVolumeARN(String volumeARN) The Amazon Resource Name (ARN) of the volume.

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

UpdateSnapshotScheduleRequest

public UpdateSnapshotScheduleRequest()

Method Detail

getVolumeARN

public String getVolumeARN()

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

Returns:

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

setVolumeARN

public void setVolumeARN(String volumeARN)

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

Parameters:

volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

withVolumeARN

public UpdateSnapshotScheduleRequest withVolumeARN(String volumeARN)

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

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

Constraints:
Length: 50 - 500

Parameters:

volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Returns:

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

getStartAt

public Integer getStartAt()

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

Constraints:
Range: 0 - 23

Returns:

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

setStartAt

public void setStartAt(Integer startAt)

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

Constraints:
Range: 0 - 23

Parameters:

startAt - The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

withStartAt

public UpdateSnapshotScheduleRequest withStartAt(Integer startAt)

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

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

Constraints:
Range: 0 - 23

Parameters:

startAt - The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

Returns:

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

getRecurrenceInHours

public Integer getRecurrenceInHours()

Frequency of snapshots. Specify the number of hours between snapshots.

Constraints:
Range: 1 - 24

Returns:

Frequency of snapshots. Specify the number of hours between snapshots.

setRecurrenceInHours

public void setRecurrenceInHours(Integer recurrenceInHours)

Frequency of snapshots. Specify the number of hours between snapshots.

Constraints:
Range: 1 - 24

Parameters:

recurrenceInHours - Frequency of snapshots. Specify the number of hours between snapshots.

withRecurrenceInHours

public UpdateSnapshotScheduleRequest withRecurrenceInHours(Integer recurrenceInHours)

Frequency of snapshots. Specify the number of hours between snapshots.

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

Constraints:
Range: 1 - 24

Parameters:

recurrenceInHours - Frequency of snapshots. Specify the number of hours between snapshots.

Returns:

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

getDescription

public String getDescription()

Optional description of the snapshot that overwrites the existing description.

Constraints:
Length: 1 - 255

Returns:

Optional description of the snapshot that overwrites the existing description.

setDescription

public void setDescription(String description)

Optional description of the snapshot that overwrites the existing description.

Constraints:
Length: 1 - 255

Parameters:

description - Optional description of the snapshot that overwrites the existing description.

withDescription

public UpdateSnapshotScheduleRequest withDescription(String description)

Optional description of the snapshot that overwrites the existing description.

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

Constraints:
Length: 1 - 255

Parameters:

description - Optional description of the snapshot that overwrites the existing description.

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