com.amazonaws.services.fsx.model.CreateBackupRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-fsx 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.fsx.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The request object for the CreateBackup operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateBackupRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID of the file system to back up.
*
*/
private String fileSystemId;
/**
*
* (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string
* is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services
* SDK.
*
*/
private String clientRequestToken;
/**
*
* (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears
* in the console as the backup name. If you have set CopyTagsToBackups to true, and you
* specify one or more tags using the CreateBackup operation, no existing file system tags are copied
* from the file system to the backup.
*
*/
private java.util.List tags;
/**
*
* (Optional) The ID of the FSx for ONTAP volume to back up.
*
*/
private String volumeId;
/**
*
* The ID of the file system to back up.
*
*
* @param fileSystemId
* The ID of the file system to back up.
*/
public void setFileSystemId(String fileSystemId) {
this.fileSystemId = fileSystemId;
}
/**
*
* The ID of the file system to back up.
*
*
* @return The ID of the file system to back up.
*/
public String getFileSystemId() {
return this.fileSystemId;
}
/**
*
* The ID of the file system to back up.
*
*
* @param fileSystemId
* The ID of the file system to back up.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateBackupRequest withFileSystemId(String fileSystemId) {
setFileSystemId(fileSystemId);
return this;
}
/**
*
* (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string
* is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services
* SDK.
*
*
* @param clientRequestToken
* (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This
* string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon
* Web Services SDK.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
*
* (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string
* is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services
* SDK.
*
*
* @return (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This
* string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon
* Web Services SDK.
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
*
* (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string
* is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services
* SDK.
*
*
* @param clientRequestToken
* (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This
* string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon
* Web Services SDK.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateBackupRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
*
* (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears
* in the console as the backup name. If you have set CopyTagsToBackups to true, and you
* specify one or more tags using the CreateBackup operation, no existing file system tags are copied
* from the file system to the backup.
*
*
* @return (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag
* appears in the console as the backup name. If you have set CopyTagsToBackups to
* true, and you specify one or more tags using the CreateBackup operation, no
* existing file system tags are copied from the file system to the backup.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears
* in the console as the backup name. If you have set CopyTagsToBackups to true, and you
* specify one or more tags using the CreateBackup operation, no existing file system tags are copied
* from the file system to the backup.
*
*
* @param tags
* (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag
* appears in the console as the backup name. If you have set CopyTagsToBackups to
* true, and you specify one or more tags using the CreateBackup operation, no
* existing file system tags are copied from the file system to the backup.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears
* in the console as the backup name. If you have set CopyTagsToBackups to true, and you
* specify one or more tags using the CreateBackup operation, no existing file system tags are copied
* from the file system to the backup.
*
*
* 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
* (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag
* appears in the console as the backup name. If you have set CopyTagsToBackups to
* true, and you specify one or more tags using the CreateBackup operation, no
* existing file system tags are copied from the file system to the backup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateBackupRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears
* in the console as the backup name. If you have set CopyTagsToBackups to true, and you
* specify one or more tags using the CreateBackup operation, no existing file system tags are copied
* from the file system to the backup.
*
*
* @param tags
* (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag
* appears in the console as the backup name. If you have set CopyTagsToBackups to
* true, and you specify one or more tags using the CreateBackup operation, no
* existing file system tags are copied from the file system to the backup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateBackupRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* (Optional) The ID of the FSx for ONTAP volume to back up.
*
*
* @param volumeId
* (Optional) The ID of the FSx for ONTAP volume to back up.
*/
public void setVolumeId(String volumeId) {
this.volumeId = volumeId;
}
/**
*
* (Optional) The ID of the FSx for ONTAP volume to back up.
*
*
* @return (Optional) The ID of the FSx for ONTAP volume to back up.
*/
public String getVolumeId() {
return this.volumeId;
}
/**
*
* (Optional) The ID of the FSx for ONTAP volume to back up.
*
*
* @param volumeId
* (Optional) The ID of the FSx for ONTAP volume to back up.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateBackupRequest withVolumeId(String volumeId) {
setVolumeId(volumeId);
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 (getFileSystemId() != null)
sb.append("FileSystemId: ").append(getFileSystemId()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getVolumeId() != null)
sb.append("VolumeId: ").append(getVolumeId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateBackupRequest == false)
return false;
CreateBackupRequest other = (CreateBackupRequest) obj;
if (other.getFileSystemId() == null ^ this.getFileSystemId() == null)
return false;
if (other.getFileSystemId() != null && other.getFileSystemId().equals(this.getFileSystemId()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getVolumeId() == null ^ this.getVolumeId() == null)
return false;
if (other.getVolumeId() != null && other.getVolumeId().equals(this.getVolumeId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFileSystemId() == null) ? 0 : getFileSystemId().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getVolumeId() == null) ? 0 : getVolumeId().hashCode());
return hashCode;
}
@Override
public CreateBackupRequest clone() {
return (CreateBackupRequest) super.clone();
}
}