software.amazon.awssdk.services.appstream.model

Class AppBlock

java.lang.Object

software.amazon.awssdk.services.appstream.model.AppBlock

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AppBlock.Builder,AppBlock>

@Generated(value="software.amazon.awssdk:codegen")
public final class AppBlock
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AppBlock.Builder,AppBlock>

Describes an app block.

App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.

This is only supported for Elastic fleets.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AppBlock.Builder

Method Summary

Modifier and Type	Method and Description
List<ErrorDetails>	appBlockErrors() The errors of the app block.
String	arn() The ARN of the app block.
static AppBlock.Builder	builder()
Instant	createdTime() The created time of the app block.
String	description() The description of the app block.
String	displayName() The display name of the app block.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAppBlockErrors() For responses, this returns true if the service returned a value for the AppBlockErrors property.
int	hashCode()
String	name() The name of the app block.
PackagingType	packagingType() The packaging type of the app block.
String	packagingTypeAsString() The packaging type of the app block.
ScriptDetails	postSetupScriptDetails() The post setup script details of the app block.
List<SdkField<?>>	sdkFields()
static Class<? extends AppBlock.Builder>	serializableBuilderClass()
ScriptDetails	setupScriptDetails() The setup script details of the app block.
S3Location	sourceS3Location() The source S3 location of the app block.
AppBlockState	state() The state of the app block.
String	stateAsString() The state of the app block.
AppBlock.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

name

public final String name()

The name of the app block.

Returns:

The name of the app block.

arn

public final String arn()

The ARN of the app block.

Returns:

The ARN of the app block.

description

public final String description()

The description of the app block.

Returns:

The description of the app block.

displayName

public final String displayName()

The display name of the app block.

Returns:

The display name of the app block.

sourceS3Location

public final S3Location sourceS3Location()

The source S3 location of the app block.

Returns:

The source S3 location of the app block.

setupScriptDetails

public final ScriptDetails setupScriptDetails()

The setup script details of the app block.

This only applies to app blocks with PackagingType CUSTOM.

Returns:

The setup script details of the app block.

This only applies to app blocks with PackagingType CUSTOM.

createdTime

public final Instant createdTime()

The created time of the app block.

Returns:

The created time of the app block.

postSetupScriptDetails

public final ScriptDetails postSetupScriptDetails()

The post setup script details of the app block.

This only applies to app blocks with PackagingType APPSTREAM2.

Returns:

The post setup script details of the app block.

This only applies to app blocks with PackagingType APPSTREAM2.

packagingType

public final PackagingType packagingType()

The packaging type of the app block.

If the service returns an enum value that is not available in the current SDK version, packagingType will return PackagingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packagingTypeAsString().

Returns:

The packaging type of the app block.

See Also:

PackagingType

packagingTypeAsString

public final String packagingTypeAsString()

The packaging type of the app block.

If the service returns an enum value that is not available in the current SDK version, packagingType will return PackagingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packagingTypeAsString().

Returns:

The packaging type of the app block.

See Also:

PackagingType

state

public final AppBlockState state()

The state of the app block.

An app block with AppStream 2.0 packaging will be in the INACTIVE state if no application package (VHD) is assigned to it. After an application package (VHD) is created by an app block builder for an app block, it becomes ACTIVE.

Custom app blocks are always in the ACTIVE state and no action is required to use them.

If the service returns an enum value that is not available in the current SDK version, state will return AppBlockState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the app block.

An app block with AppStream 2.0 packaging will be in the INACTIVE state if no application package (VHD) is assigned to it. After an application package (VHD) is created by an app block builder for an app block, it becomes ACTIVE.

Custom app blocks are always in the ACTIVE state and no action is required to use them.

See Also:

AppBlockState

stateAsString

public final String stateAsString()

The state of the app block.

An app block with AppStream 2.0 packaging will be in the INACTIVE state if no application package (VHD) is assigned to it. After an application package (VHD) is created by an app block builder for an app block, it becomes ACTIVE.

Custom app blocks are always in the ACTIVE state and no action is required to use them.

If the service returns an enum value that is not available in the current SDK version, state will return AppBlockState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the app block.

An app block with AppStream 2.0 packaging will be in the INACTIVE state if no application package (VHD) is assigned to it. After an application package (VHD) is created by an app block builder for an app block, it becomes ACTIVE.

Custom app blocks are always in the ACTIVE state and no action is required to use them.

See Also:

AppBlockState

hasAppBlockErrors

public final boolean hasAppBlockErrors()

For responses, this returns true if the service returned a value for the AppBlockErrors 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.

appBlockErrors

public final List<ErrorDetails> appBlockErrors()

The errors of the app block.

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 hasAppBlockErrors() method.

Returns:

The errors of the app block.

toBuilder

public AppBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AppBlock.Builder,AppBlock>

builder

public static AppBlock.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo