com.amazonaws.services.storagegateway.model.CreateSnapshotRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-storagegateway Show documentation
/*
* Copyright 2019-2024 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* A JSON object containing one or more of the following fields:
*
*
* -
*
*
* -
*
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateSnapshotRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway
* volumes.
*
*/
private String volumeARN;
/**
*
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel
* in the Description field, and in the Storage Gateway snapshot Details pane, Description
* field.
*
*/
private String snapshotDescription;
/**
*
* A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway
* volumes.
*
*
* @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.
*
*
* @return The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of
* gateway volumes.
*/
public String getVolumeARN() {
return this.volumeARN;
}
/**
*
* The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway
* volumes.
*
*
* @param volumeARN
* The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of
* gateway volumes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withVolumeARN(String volumeARN) {
setVolumeARN(volumeARN);
return this;
}
/**
*
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel
* in the Description field, and in the Storage Gateway snapshot Details pane, Description
* field.
*
*
* @param snapshotDescription
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots
* panel in the Description field, and in the Storage Gateway snapshot Details pane,
* Description field.
*/
public void setSnapshotDescription(String snapshotDescription) {
this.snapshotDescription = snapshotDescription;
}
/**
*
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel
* in the Description field, and in the Storage Gateway snapshot Details pane, Description
* field.
*
*
* @return Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots
* panel in the Description field, and in the Storage Gateway snapshot Details pane,
* Description field.
*/
public String getSnapshotDescription() {
return this.snapshotDescription;
}
/**
*
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel
* in the Description field, and in the Storage Gateway snapshot Details pane, Description
* field.
*
*
* @param snapshotDescription
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots
* panel in the Description field, and in the Storage Gateway snapshot Details pane,
* Description field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withSnapshotDescription(String snapshotDescription) {
setSnapshotDescription(snapshotDescription);
return this;
}
/**
*
* A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
*
*
* @return A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and
* the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters,
* and the maximum length for a tag's value is 256.
*
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
*
*
* @param tags
* A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and
* the maximum length for a tag's value is 256.
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and
* the maximum length for a tag's value is 256.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
*
*
* @param tags
* A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and
* the maximum length for a tag's value is 256.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSnapshotRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @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: ").append(getVolumeARN()).append(",");
if (getSnapshotDescription() != null)
sb.append("SnapshotDescription: ").append(getSnapshotDescription()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateSnapshotRequest == false)
return false;
CreateSnapshotRequest other = (CreateSnapshotRequest) obj;
if (other.getVolumeARN() == null ^ this.getVolumeARN() == null)
return false;
if (other.getVolumeARN() != null && other.getVolumeARN().equals(this.getVolumeARN()) == false)
return false;
if (other.getSnapshotDescription() == null ^ this.getSnapshotDescription() == null)
return false;
if (other.getSnapshotDescription() != null && other.getSnapshotDescription().equals(this.getSnapshotDescription()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVolumeARN() == null) ? 0 : getVolumeARN().hashCode());
hashCode = prime * hashCode + ((getSnapshotDescription() == null) ? 0 : getSnapshotDescription().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateSnapshotRequest clone() {
return (CreateSnapshotRequest) super.clone();
}
}