Class CreateDiskFromSnapshotRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.lightsail.model.LightsailRequest
-
- software.amazon.awssdk.services.lightsail.model.CreateDiskFromSnapshotRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateDiskFromSnapshotRequest.Builder,CreateDiskFromSnapshotRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDiskFromSnapshotRequest extends LightsailRequest implements ToCopyableBuilder<CreateDiskFromSnapshotRequest.Builder,CreateDiskFromSnapshotRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDiskFromSnapshotRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AddOnRequest>addOns()An array of objects that represent the add-ons to enable for the new disk.StringavailabilityZone()The Availability Zone where you want to create the disk (us-east-2a).static CreateDiskFromSnapshotRequest.Builderbuilder()StringdiskName()The unique Lightsail disk name (my-disk).StringdiskSnapshotName()The name of the disk snapshot (my-snapshot) from which to create the new storage disk.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAddOns()For responses, this returns true if the service returned a value for the AddOns property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringrestoreDate()The date of the automatic snapshot to use for the new disk.List<SdkField<?>>sdkFields()static Class<? extends CreateDiskFromSnapshotRequest.Builder>serializableBuilderClass()IntegersizeInGb()The size of the disk in GB (32).StringsourceDiskName()The name of the source disk from which the source automatic snapshot was created.List<Tag>tags()The tag keys and optional values to add to the resource during create.CreateDiskFromSnapshotRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleanuseLatestRestorableAutoSnapshot()A Boolean value to indicate whether to use the latest available automatic snapshot.-
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
-
diskName
public final String diskName()
The unique Lightsail disk name (
my-disk).- Returns:
- The unique Lightsail disk name (
my-disk).
-
diskSnapshotName
public final String diskSnapshotName()
The name of the disk snapshot (
my-snapshot) from which to create the new storage disk.Constraint:
-
This parameter cannot be defined together with the
source disk nameparameter. Thedisk snapshot nameandsource disk nameparameters are mutually exclusive.
- Returns:
- The name of the disk snapshot (
my-snapshot) from which to create the new storage disk.Constraint:
-
This parameter cannot be defined together with the
source disk nameparameter. Thedisk snapshot nameandsource disk nameparameters are mutually exclusive.
-
-
-
availabilityZone
public final String availabilityZone()
The Availability Zone where you want to create the disk (
us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
- Returns:
- The Availability Zone where you want to create the disk (
us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
-
sizeInGb
public final Integer sizeInGb()
The size of the disk in GB (
32).- Returns:
- The size of the disk in GB (
32).
-
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 theisEmpty()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()
The tag keys and optional values to add to the resource during create.
Use the
TagResourceaction to tag a resource after it's created.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:
- The tag keys and optional values to add to the resource during create.
Use the
TagResourceaction to tag a resource after it's created.
-
hasAddOns
public final boolean hasAddOns()
For responses, this returns true if the service returned a value for the AddOns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
addOns
public final List<AddOnRequest> addOns()
An array of objects that represent the add-ons to enable for the new disk.
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
hasAddOns()method.- Returns:
- An array of objects that represent the add-ons to enable for the new disk.
-
sourceDiskName
public final String sourceDiskName()
The name of the source disk from which the source automatic snapshot was created.
Constraints:
-
This parameter cannot be defined together with the
disk snapshot nameparameter. Thesource disk nameanddisk snapshot nameparameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- The name of the source disk from which the source automatic snapshot was created.
Constraints:
-
This parameter cannot be defined together with the
disk snapshot nameparameter. Thesource disk nameanddisk snapshot nameparameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
restoreDate
public final String restoreDate()
The date of the automatic snapshot to use for the new disk. Use the
get auto snapshotsoperation to identify the dates of the available automatic snapshots.Constraints:
-
Must be specified in
YYYY-MM-DDformat. -
This parameter cannot be defined together with the
use latest restorable auto snapshotparameter. Therestore dateanduse latest restorable auto snapshotparameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- The date of the automatic snapshot to use for the new disk. Use the
get auto snapshotsoperation to identify the dates of the available automatic snapshots.Constraints:
-
Must be specified in
YYYY-MM-DDformat. -
This parameter cannot be defined together with the
use latest restorable auto snapshotparameter. Therestore dateanduse latest restorable auto snapshotparameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
useLatestRestorableAutoSnapshot
public final Boolean useLatestRestorableAutoSnapshot()
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
-
This parameter cannot be defined together with the
restore dateparameter. Theuse latest restorable auto snapshotandrestore dateparameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
-
This parameter cannot be defined together with the
restore dateparameter. Theuse latest restorable auto snapshotandrestore dateparameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
toBuilder
public CreateDiskFromSnapshotRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateDiskFromSnapshotRequest.Builder,CreateDiskFromSnapshotRequest>- Specified by:
toBuilderin classLightsailRequest
-
builder
public static CreateDiskFromSnapshotRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDiskFromSnapshotRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-