software.amazon.awssdk.services.fsx.model

Class CreateBackupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.fsx.model.FSxRequest

software.amazon.awssdk.services.fsx.model.CreateBackupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBackupRequest.Builder,CreateBackupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateBackupRequest
extends FSxRequest
implements ToCopyableBuilder<CreateBackupRequest.Builder,CreateBackupRequest>

The request object for the CreateBackup operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBackupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateBackupRequest.Builder	builder()
String	clientRequestToken() (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemId() The ID of the file system to back up.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBackupRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() (Optional) The tags to apply to the backup at backup creation.
CreateBackupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	volumeId() (Optional) The ID of the FSx for ONTAP volume to back up.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fileSystemId

public final String fileSystemId()

The ID of the file system to back up.

Returns:

The ID of the file system to back up.

clientRequestToken

public final 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.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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.

volumeId

public final String volumeId()

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

toBuilder

public CreateBackupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBackupRequest.Builder,CreateBackupRequest>

Specified by:

toBuilder in class FSxRequest

builder

public static CreateBackupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBackupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo