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 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.
boolean	equals(Object obj)
String	fileSystemId() The ID of the file system to back up.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBackupRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags to apply to the backup at backup creation.
CreateBackupRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

fileSystemId

public String fileSystemId()

The ID of the file system to back up.

Returns:

The ID of the file system to back up.

clientRequestToken

public String clientRequestToken()

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Returns:

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

tags

public List<Tag> tags()

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.

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

Returns:

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.

toBuilder

public CreateBackupRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBackupRequest.Builder,CreateBackupRequest>

Specified by:

toBuilder in class FSxRequest

Returns:

a builder for type T

builder

public static CreateBackupRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.