com.amazonaws.services.fsx.model

Class CreateBackupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.fsx.model.CreateBackupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateBackupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The request object for the CreateBackup operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateBackupRequest()

Method Summary

Modifier and Type	Method and Description
CreateBackupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation.
String	getFileSystemId() The ID of the file system to back up.
List<Tag>	getTags() (Optional) The tags to apply to the backup at backup creation.
String	getVolumeId() (Optional) The ID of the FSx for ONTAP volume to back up.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation.
void	setFileSystemId(String fileSystemId) The ID of the file system to back up.
void	setTags(Collection<Tag> tags) (Optional) The tags to apply to the backup at backup creation.
void	setVolumeId(String volumeId) (Optional) The ID of the FSx for ONTAP volume to back up.
String	toString() Returns a string representation of this object.
CreateBackupRequest	withClientRequestToken(String clientRequestToken) (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation.
CreateBackupRequest	withFileSystemId(String fileSystemId) The ID of the file system to back up.
CreateBackupRequest	withTags(Collection<Tag> tags) (Optional) The tags to apply to the backup at backup creation.
CreateBackupRequest	withTags(Tag... tags) (Optional) The tags to apply to the backup at backup creation.
CreateBackupRequest	withVolumeId(String volumeId) (Optional) The ID of the FSx for ONTAP volume to back up.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateBackupRequest

public CreateBackupRequest()

Method Detail

setFileSystemId

public void setFileSystemId(String fileSystemId)

The ID of the file system to back up.

Parameters:

fileSystemId - The ID of the file system to back up.

getFileSystemId

public String getFileSystemId()

The ID of the file system to back up.

Returns:

The ID of the file system to back up.

withFileSystemId

public CreateBackupRequest withFileSystemId(String fileSystemId)

The ID of the file system to back up.

Parameters:

fileSystemId - The ID of the file system to back up.

Returns:

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

setClientRequestToken

public void setClientRequestToken(String 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.

Parameters:

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.

getClientRequestToken

public String getClientRequestToken()

(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.

Returns:

(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.

withClientRequestToken

public CreateBackupRequest withClientRequestToken(String 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.

Parameters:

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.

Returns:

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

getTags

public List<Tag> getTags()

(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.

Returns:

(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.

setTags

public void setTags(Collection<Tag> 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.

Parameters:

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.

withTags

public CreateBackupRequest withTags(Tag... 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 setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

withTags

public CreateBackupRequest withTags(Collection<Tag> 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.

Parameters:

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.

Returns:

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

setVolumeId

public void setVolumeId(String volumeId)

(Optional) The ID of the FSx for ONTAP volume to back up.

Parameters:

volumeId - (Optional) The ID of the FSx for ONTAP volume to back up.

getVolumeId

public String getVolumeId()

(Optional) The ID of the FSx for ONTAP volume to back up.

Returns:

(Optional) The ID of the FSx for ONTAP volume to back up.

withVolumeId

public CreateBackupRequest withVolumeId(String volumeId)

(Optional) The ID of the FSx for ONTAP volume to back up.

Parameters:

volumeId - (Optional) The ID of the FSx for ONTAP volume to back up.

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateBackupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()