software.amazon.awssdk.services.fsx.model

Interface Volume.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Volume.Builder,Volume>, SdkBuilder<Volume.Builder,Volume>, SdkPojo

Enclosing class:

Volume

public static interface Volume.Builder
extends SdkPojo, CopyableBuilder<Volume.Builder,Volume>

Method Summary

Modifier and Type	Method and Description
Volume.Builder	administrativeActions(AdministrativeAction... administrativeActions) A list of administrative actions for the volume that are in process or waiting to be processed.
Volume.Builder	administrativeActions(Collection<AdministrativeAction> administrativeActions) A list of administrative actions for the volume that are in process or waiting to be processed.
Volume.Builder	administrativeActions(Consumer<AdministrativeAction.Builder>... administrativeActions) A list of administrative actions for the volume that are in process or waiting to be processed.
Volume.Builder	creationTime(Instant creationTime) Sets the value of the CreationTime property for this object.
Volume.Builder	fileSystemId(String fileSystemId) Sets the value of the FileSystemId property for this object.
Volume.Builder	lifecycle(String lifecycle) The lifecycle status of the volume.
Volume.Builder	lifecycle(VolumeLifecycle lifecycle) The lifecycle status of the volume.
default Volume.Builder	lifecycleTransitionReason(Consumer<LifecycleTransitionReason.Builder> lifecycleTransitionReason) The reason why the volume lifecycle status changed.
Volume.Builder	lifecycleTransitionReason(LifecycleTransitionReason lifecycleTransitionReason) The reason why the volume lifecycle status changed.
Volume.Builder	name(String name) The name of the volume.
default Volume.Builder	ontapConfiguration(Consumer<OntapVolumeConfiguration.Builder> ontapConfiguration) Sets the value of the OntapConfiguration property for this object.
Volume.Builder	ontapConfiguration(OntapVolumeConfiguration ontapConfiguration) Sets the value of the OntapConfiguration property for this object.
default Volume.Builder	openZFSConfiguration(Consumer<OpenZFSVolumeConfiguration.Builder> openZFSConfiguration) The configuration of an Amazon FSx for OpenZFS volume.
Volume.Builder	openZFSConfiguration(OpenZFSVolumeConfiguration openZFSConfiguration) The configuration of an Amazon FSx for OpenZFS volume.
Volume.Builder	resourceARN(String resourceARN) Sets the value of the ResourceARN property for this object.
Volume.Builder	tags(Collection<Tag> tags) Sets the value of the Tags property for this object.
Volume.Builder	tags(Consumer<Tag.Builder>... tags) Sets the value of the Tags property for this object.
Volume.Builder	tags(Tag... tags) Sets the value of the Tags property for this object.
Volume.Builder	volumeId(String volumeId) The system-generated, unique ID of the volume.
Volume.Builder	volumeType(String volumeType) The type of the volume.
Volume.Builder	volumeType(VolumeType volumeType) The type of the volume.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

creationTime

Volume.Builder creationTime(Instant creationTime)

Sets the value of the CreationTime property for this object.

Parameters:

creationTime - The new value for the CreationTime property for this object.

Returns:

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

fileSystemId

Volume.Builder fileSystemId(String fileSystemId)

Sets the value of the FileSystemId property for this object.

Parameters:

fileSystemId - The new value for the FileSystemId property for this object.

Returns:

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

lifecycle

Volume.Builder lifecycle(String lifecycle)

The lifecycle status of the volume.

• AVAILABLE - The volume is fully available for use.

• CREATED - The volume has been created.

• CREATING - Amazon FSx is creating the new volume.

• DELETING - Amazon FSx is deleting an existing volume.

• FAILED - Amazon FSx was unable to create the volume.

• MISCONFIGURED - The volume is in a failed but recoverable state.

• PENDING - Amazon FSx hasn't started creating the volume.

Parameters:

lifecycle - The lifecycle status of the volume.

• AVAILABLE - The volume is fully available for use.

• CREATED - The volume has been created.

• CREATING - Amazon FSx is creating the new volume.

• DELETING - Amazon FSx is deleting an existing volume.

• FAILED - Amazon FSx was unable to create the volume.

• MISCONFIGURED - The volume is in a failed but recoverable state.

• PENDING - Amazon FSx hasn't started creating the volume.

Returns:

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

See Also:

VolumeLifecycle, VolumeLifecycle

lifecycle

Volume.Builder lifecycle(VolumeLifecycle lifecycle)

The lifecycle status of the volume.

• AVAILABLE - The volume is fully available for use.

• CREATED - The volume has been created.

• CREATING - Amazon FSx is creating the new volume.

• DELETING - Amazon FSx is deleting an existing volume.

• FAILED - Amazon FSx was unable to create the volume.

• MISCONFIGURED - The volume is in a failed but recoverable state.

• PENDING - Amazon FSx hasn't started creating the volume.

Parameters:

lifecycle - The lifecycle status of the volume.

• AVAILABLE - The volume is fully available for use.

• CREATED - The volume has been created.

• CREATING - Amazon FSx is creating the new volume.

• DELETING - Amazon FSx is deleting an existing volume.

• FAILED - Amazon FSx was unable to create the volume.

• MISCONFIGURED - The volume is in a failed but recoverable state.

• PENDING - Amazon FSx hasn't started creating the volume.

Returns:

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

See Also:

VolumeLifecycle, VolumeLifecycle

name

Volume.Builder name(String name)

The name of the volume.

Parameters:

name - The name of the volume.

Returns:

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

ontapConfiguration

Volume.Builder ontapConfiguration(OntapVolumeConfiguration ontapConfiguration)

Sets the value of the OntapConfiguration property for this object.

Parameters:

ontapConfiguration - The new value for the OntapConfiguration property for this object.

Returns:

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

ontapConfiguration

default Volume.Builder ontapConfiguration(Consumer<OntapVolumeConfiguration.Builder> ontapConfiguration)

Sets the value of the OntapConfiguration property for this object. This is a convenience method that creates an instance of the OntapVolumeConfiguration.Builder avoiding the need to create one manually via OntapVolumeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ontapConfiguration(OntapVolumeConfiguration).

Parameters:

ontapConfiguration - a consumer that will call methods on OntapVolumeConfiguration.Builder

Returns:

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

See Also:

ontapConfiguration(OntapVolumeConfiguration)

resourceARN

Volume.Builder resourceARN(String resourceARN)

Sets the value of the ResourceARN property for this object.

Parameters:

resourceARN - The new value for the ResourceARN property for this object.

Returns:

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

tags

Volume.Builder tags(Collection<Tag> tags)

Sets the value of the Tags property for this object.

Parameters:

tags - The new value for the Tags property for this object.

Returns:

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

tags

Volume.Builder tags(Tag... tags)

Sets the value of the Tags property for this object.

Parameters:

tags - The new value for the Tags property for this object.

Returns:

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

tags

Volume.Builder tags(Consumer<Tag.Builder>... tags)

Sets the value of the Tags property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

volumeId

Volume.Builder volumeId(String volumeId)

The system-generated, unique ID of the volume.

Parameters:

volumeId - The system-generated, unique ID of the volume.

Returns:

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

volumeType

Volume.Builder volumeType(String volumeType)

The type of the volume.

Parameters:

volumeType - The type of the volume.

Returns:

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

See Also:

VolumeType, VolumeType

volumeType

Volume.Builder volumeType(VolumeType volumeType)

The type of the volume.

Parameters:

volumeType - The type of the volume.

Returns:

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

See Also:

VolumeType, VolumeType

lifecycleTransitionReason

Volume.Builder lifecycleTransitionReason(LifecycleTransitionReason lifecycleTransitionReason)

The reason why the volume lifecycle status changed.

Parameters:

lifecycleTransitionReason - The reason why the volume lifecycle status changed.

Returns:

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

lifecycleTransitionReason

default Volume.Builder lifecycleTransitionReason(Consumer<LifecycleTransitionReason.Builder> lifecycleTransitionReason)

The reason why the volume lifecycle status changed.

This is a convenience method that creates an instance of the LifecycleTransitionReason.Builder avoiding the need to create one manually via LifecycleTransitionReason.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifecycleTransitionReason(LifecycleTransitionReason).

Parameters:

lifecycleTransitionReason - a consumer that will call methods on LifecycleTransitionReason.Builder

Returns:

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

See Also:

lifecycleTransitionReason(LifecycleTransitionReason)

administrativeActions

Volume.Builder administrativeActions(Collection<AdministrativeAction> administrativeActions)

A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

Parameters:

administrativeActions - A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

Returns:

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

administrativeActions

Volume.Builder administrativeActions(AdministrativeAction... administrativeActions)

A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

Parameters:

administrativeActions - A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

Returns:

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

administrativeActions

Volume.Builder administrativeActions(Consumer<AdministrativeAction.Builder>... administrativeActions)

A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

This is a convenience method that creates an instance of the AdministrativeAction.Builder avoiding the need to create one manually via AdministrativeAction.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #administrativeActions(List).

Parameters:

administrativeActions - a consumer that will call methods on AdministrativeAction.Builder

Returns:

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

See Also:

#administrativeActions(java.util.Collection)

openZFSConfiguration

Volume.Builder openZFSConfiguration(OpenZFSVolumeConfiguration openZFSConfiguration)

The configuration of an Amazon FSx for OpenZFS volume.

Parameters:

openZFSConfiguration - The configuration of an Amazon FSx for OpenZFS volume.

Returns:

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

openZFSConfiguration

default Volume.Builder openZFSConfiguration(Consumer<OpenZFSVolumeConfiguration.Builder> openZFSConfiguration)

The configuration of an Amazon FSx for OpenZFS volume.

This is a convenience method that creates an instance of the OpenZFSVolumeConfiguration.Builder avoiding the need to create one manually via OpenZFSVolumeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openZFSConfiguration(OpenZFSVolumeConfiguration).

Parameters:

openZFSConfiguration - a consumer that will call methods on OpenZFSVolumeConfiguration.Builder

Returns:

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

See Also:

openZFSConfiguration(OpenZFSVolumeConfiguration)