CreateDiskFromSnapshotRequest (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class CreateDiskFromSnapshotRequest
extends LightsailRequest
implements ToCopyableBuilder<CreateDiskFromSnapshotRequest.Builder,CreateDiskFromSnapshotRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateDiskFromSnapshotRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDiskFromSnapshotRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AddOnRequest>`	`addOns()` An array of objects that represent the add-ons to enable for the new disk.
`String`	`availabilityZone()` The Availability Zone where you want to create the disk (e.g., `us-east-2a`).
`static CreateDiskFromSnapshotRequest.Builder`	`builder()`
`String`	`diskName()` The unique Lightsail disk name (e.g., `my-disk`).
`String`	`diskSnapshotName()` The name of the disk snapshot (e.g., `my-snapshot`) from which to create the new storage disk.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`boolean`	`hasAddOns()` For responses, this returns true if the service returned a value for the AddOns property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`restoreDate()` The date of the automatic snapshot to use for the new disk.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDiskFromSnapshotRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`sizeInGb()` The size of the disk in GB (e.g., `32`).
`String`	`sourceDiskName()` 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.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`useLatestRestorableAutoSnapshot()` 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
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 (e.g., my-disk).
    
    Returns:
    
    The unique Lightsail disk name (e.g., my-disk).
  - diskSnapshotName
```
public final String diskSnapshotName()
```
    The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.
    
    Constraint:
    - This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.
    Returns:
    The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.
    
    Constraint:
    
    This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.
  - availabilityZone
```
public final String availabilityZone()
```
    The Availability Zone where you want to create the disk (e.g., 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 (e.g., 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 (e.g., 32).
    
    Returns:
    
    The size of the disk in GB (e.g., 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 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()
```
    The tag keys and optional values to add to the resource during create.
    
    Use the TagResource action 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 TagResource action 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 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.
  - 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 name parameter. The source disk name and disk snapshot name parameters 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 name parameter. The source disk name and disk snapshot name parameters 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 snapshots operation to identify the dates of the available automatic snapshots.
    
    Constraints:
    - Must be specified in YYYY-MM-DD format.
    - This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters 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 snapshots operation to identify the dates of the available automatic snapshots.
    
    Constraints:
    
    Must be specified in YYYY-MM-DD format.
    
    This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters 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 date parameter. The use latest restorable auto snapshot and restore date parameters 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 date parameter. The use latest restorable auto snapshot and restore date parameters 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()
```
    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<CreateDiskFromSnapshotRequest.Builder,CreateDiskFromSnapshotRequest>
    
    Specified by:
    
    toBuilder in class LightsailRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateDiskFromSnapshotRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDiskFromSnapshotRequest.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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    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 final 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.

AWS SDK for Java API Reference - 2.17.61

Class CreateDiskFromSnapshotRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

diskName

diskSnapshotName

availabilityZone

sizeInGb

hasTags

tags

hasAddOns

addOns

sourceDiskName

restoreDate

useLatestRestorableAutoSnapshot

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields