com.amazonaws.services.storagegateway.model.UpdateSnapshotScheduleRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2014 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.storagegateway.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.storagegateway.AWSStorageGateway#updateSnapshotSchedule(UpdateSnapshotScheduleRequest) 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 snapshot 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 com.amazonaws.services.storagegateway.AWSStorageGateway#updateSnapshotSchedule(UpdateSnapshotScheduleRequest)
*/
public class UpdateSnapshotScheduleRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The Amazon Resource Name (ARN) of the volume. Use the
* ListVolumes operation to return a list of gateway volumes.
*
* Constraints:
* Length: 50 - 500
*/
private String volumeARN;
/**
* 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
*/
private Integer startAt;
/**
* Frequency of snapshots. Specify the number of hours between snapshots.
*
* Constraints:
* Range: 1 - 24
*/
private Integer recurrenceInHours;
/**
* Optional description of the snapshot that overwrites the existing
* description.
*
* Constraints:
* Length: 1 - 255
*/
private String description;
/**
* The Amazon Resource Name (ARN) of the volume. Use the
* ListVolumes operation to return a list of gateway volumes.
*
* Constraints:
* Length: 50 - 500
*
* @return The Amazon Resource Name (ARN) of the volume. Use the
* ListVolumes operation to return a list of gateway volumes.
*/
public String getVolumeARN() {
return volumeARN;
}
/**
* The Amazon Resource Name (ARN) of the volume. Use the
* ListVolumes operation to return a list of gateway volumes.
*
* Constraints:
* Length: 50 - 500
*
* @param volumeARN The Amazon Resource Name (ARN) of the volume. Use the
* ListVolumes operation to return a list of gateway volumes.
*/
public void setVolumeARN(String volumeARN) {
this.volumeARN = 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
*
* @param volumeARN The Amazon Resource Name (ARN) of the volume. Use the
* ListVolumes operation to return a list of gateway volumes.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateSnapshotScheduleRequest withVolumeARN(String volumeARN) {
this.volumeARN = volumeARN;
return this;
}
/**
* 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
*
* @return 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.
*/
public Integer getStartAt() {
return 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
*
* @param 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.
*/
public void setStartAt(Integer startAt) {
this.startAt = 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
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateSnapshotScheduleRequest withStartAt(Integer startAt) {
this.startAt = startAt;
return this;
}
/**
* Frequency of snapshots. Specify the number of hours between snapshots.
*
* Constraints:
* Range: 1 - 24
*
* @return Frequency of snapshots. Specify the number of hours between snapshots.
*/
public Integer getRecurrenceInHours() {
return recurrenceInHours;
}
/**
* Frequency of snapshots. Specify the number of hours between snapshots.
*
* Constraints:
* Range: 1 - 24
*
* @param recurrenceInHours Frequency of snapshots. Specify the number of hours between snapshots.
*/
public void setRecurrenceInHours(Integer recurrenceInHours) {
this.recurrenceInHours = 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
*
* @param recurrenceInHours Frequency of snapshots. Specify the number of hours between snapshots.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateSnapshotScheduleRequest withRecurrenceInHours(Integer recurrenceInHours) {
this.recurrenceInHours = recurrenceInHours;
return this;
}
/**
* Optional description of the snapshot that overwrites the existing
* description.
*
* Constraints:
* Length: 1 - 255
*
* @return Optional description of the snapshot that overwrites the existing
* description.
*/
public String getDescription() {
return description;
}
/**
* Optional description of the snapshot that overwrites the existing
* description.
*
* Constraints:
* Length: 1 - 255
*
* @param description Optional description of the snapshot that overwrites the existing
* description.
*/
public void setDescription(String description) {
this.description = 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
*
* @param description Optional description of the snapshot that overwrites the existing
* description.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateSnapshotScheduleRequest withDescription(String description) {
this.description = description;
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 (getVolumeARN() != null) sb.append("VolumeARN: " + getVolumeARN() + ",");
if (getStartAt() != null) sb.append("StartAt: " + getStartAt() + ",");
if (getRecurrenceInHours() != null) sb.append("RecurrenceInHours: " + getRecurrenceInHours() + ",");
if (getDescription() != null) sb.append("Description: " + getDescription() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVolumeARN() == null) ? 0 : getVolumeARN().hashCode());
hashCode = prime * hashCode + ((getStartAt() == null) ? 0 : getStartAt().hashCode());
hashCode = prime * hashCode + ((getRecurrenceInHours() == null) ? 0 : getRecurrenceInHours().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof UpdateSnapshotScheduleRequest == false) return false;
UpdateSnapshotScheduleRequest other = (UpdateSnapshotScheduleRequest)obj;
if (other.getVolumeARN() == null ^ this.getVolumeARN() == null) return false;
if (other.getVolumeARN() != null && other.getVolumeARN().equals(this.getVolumeARN()) == false) return false;
if (other.getStartAt() == null ^ this.getStartAt() == null) return false;
if (other.getStartAt() != null && other.getStartAt().equals(this.getStartAt()) == false) return false;
if (other.getRecurrenceInHours() == null ^ this.getRecurrenceInHours() == null) return false;
if (other.getRecurrenceInHours() != null && other.getRecurrenceInHours().equals(this.getRecurrenceInHours()) == false) return false;
if (other.getDescription() == null ^ this.getDescription() == null) return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false;
return true;
}
}