software.amazon.awssdk.services.lightsail.model

Interface Disk.Builder

All Superinterfaces:

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

Enclosing class:

Disk

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

Method Summary

Modifier and Type	Method and Description
Disk.Builder	arn(String arn) The Amazon Resource Name (ARN) of the disk.
Disk.Builder	attachedTo(String attachedTo) The resources to which the disk is attached.
Disk.Builder	attachmentState(String attachmentState) (Deprecated) The attachment state of the disk.
Disk.Builder	createdAt(Instant createdAt) The date when the disk was created.
Disk.Builder	gbInUse(Integer gbInUse) (Deprecated) The number of GB in use by the disk.
Disk.Builder	iops(Integer iops) The input/output operations per second (IOPS) of the disk.
Disk.Builder	isAttached(Boolean isAttached) A Boolean value indicating whether the disk is attached.
Disk.Builder	isSystemDisk(Boolean isSystemDisk) A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
default Disk.Builder	location(Consumer<ResourceLocation.Builder> location) The AWS Region and Availability Zone where the disk is located.
Disk.Builder	location(ResourceLocation location) The AWS Region and Availability Zone where the disk is located.
Disk.Builder	name(String name) The unique name of the disk.
Disk.Builder	path(String path) The disk path.
Disk.Builder	resourceType(ResourceType resourceType) The Lightsail resource type (e.g., Disk).
Disk.Builder	resourceType(String resourceType) The Lightsail resource type (e.g., Disk).
Disk.Builder	sizeInGb(Integer sizeInGb) The size of the disk in GB.
Disk.Builder	state(DiskState state) Describes the status of the disk.
Disk.Builder	state(String state) Describes the status of the disk.
Disk.Builder	supportCode(String supportCode) The support code.
Disk.Builder	tags(Collection<Tag> tags) The tag keys and optional values for the resource.
Disk.Builder	tags(Consumer<Tag.Builder>... tags) The tag keys and optional values for the resource.
Disk.Builder	tags(Tag... tags) The tag keys and optional values for the resource.

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

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

name

Disk.Builder name(String name)

The unique name of the disk.

Parameters:

name - The unique name of the disk.

Returns:

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

arn

Disk.Builder arn(String arn)

The Amazon Resource Name (ARN) of the disk.

Parameters:

arn - The Amazon Resource Name (ARN) of the disk.

Returns:

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

supportCode

Disk.Builder supportCode(String supportCode)

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Parameters:

supportCode - The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Returns:

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

createdAt

Disk.Builder createdAt(Instant createdAt)

The date when the disk was created.

Parameters:

createdAt - The date when the disk was created.

Returns:

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

location

Disk.Builder location(ResourceLocation location)

The AWS Region and Availability Zone where the disk is located.

Parameters:

location - The AWS Region and Availability Zone where the disk is located.

Returns:

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

location

default Disk.Builder location(Consumer<ResourceLocation.Builder> location)

The AWS Region and Availability Zone where the disk is located.

This is a convenience that creates an instance of the ResourceLocation.Builder avoiding the need to create one manually via ResourceLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(ResourceLocation).

Parameters:

location - a consumer that will call methods on ResourceLocation.Builder

Returns:

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

See Also:

location(ResourceLocation)

resourceType

Disk.Builder resourceType(String resourceType)

The Lightsail resource type (e.g., Disk).

Parameters:

resourceType - The Lightsail resource type (e.g., Disk).

Returns:

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

See Also:

ResourceType, ResourceType

resourceType

Disk.Builder resourceType(ResourceType resourceType)

The Lightsail resource type (e.g., Disk).

Parameters:

resourceType - The Lightsail resource type (e.g., Disk).

Returns:

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

See Also:

ResourceType, ResourceType

tags

Disk.Builder tags(Collection<Tag> tags)

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

Parameters:

tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

Returns:

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

tags

Disk.Builder tags(Tag... tags)

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

Parameters:

tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

Returns:

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

tags

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

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(List)

sizeInGb

Disk.Builder sizeInGb(Integer sizeInGb)

The size of the disk in GB.

Parameters:

sizeInGb - The size of the disk in GB.

Returns:

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

isSystemDisk

Disk.Builder isSystemDisk(Boolean isSystemDisk)

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

Parameters:

isSystemDisk - A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

Returns:

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

iops

Disk.Builder iops(Integer iops)

The input/output operations per second (IOPS) of the disk.

Parameters:

iops - The input/output operations per second (IOPS) of the disk.

Returns:

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

path

Disk.Builder path(String path)

The disk path.

Parameters:

path - The disk path.

Returns:

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

state

Disk.Builder state(String state)

Describes the status of the disk.

Parameters:

state - Describes the status of the disk.

Returns:

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

See Also:

DiskState, DiskState

state

Disk.Builder state(DiskState state)

Describes the status of the disk.

Parameters:

state - Describes the status of the disk.

Returns:

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

See Also:

DiskState, DiskState

attachedTo

Disk.Builder attachedTo(String attachedTo)

The resources to which the disk is attached.

Parameters:

attachedTo - The resources to which the disk is attached.

Returns:

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

isAttached

Disk.Builder isAttached(Boolean isAttached)

A Boolean value indicating whether the disk is attached.

Parameters:

isAttached - A Boolean value indicating whether the disk is attached.

Returns:

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

attachmentState

Disk.Builder attachmentState(String attachmentState)

(Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

Parameters:

attachmentState - (Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

Returns:

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

gbInUse

Disk.Builder gbInUse(Integer gbInUse)

(Deprecated) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

Parameters:

gbInUse - (Deprecated) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

Returns:

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