Class AppBlock
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<ErrorDetails> The errors of the app block.final String
arn()
The ARN of the app block.static AppBlock.Builder
builder()
final Instant
The created time of the app block.final String
The description of the app block.final String
The display name of the app block.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AppBlockErrors property.final int
hashCode()
final String
name()
The name of the app block.final PackagingType
The packaging type of the app block.final String
The packaging type of the app block.final ScriptDetails
The post setup script details of the app block.static Class
<? extends AppBlock.Builder> final ScriptDetails
The setup script details of the app block.final S3Location
The source S3 location of the app block.final AppBlockState
state()
The state of the app block.final String
The state of the app block.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the app block.
- Returns:
- The name of the app block.
-
arn
The ARN of the app block.
- Returns:
- The ARN of the app block.
-
description
The description of the app block.
- Returns:
- The description of the app block.
-
displayName
The display name of the app block.
- Returns:
- The display name of the app block.
-
sourceS3Location
The source S3 location of the app block.
- Returns:
- The source S3 location of the app block.
-
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
The created time of the app block.
- Returns:
- The created time of the app block.
-
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
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 returnPackagingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompackagingTypeAsString()
.- Returns:
- The packaging type of the app block.
- See Also:
-
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 returnPackagingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompackagingTypeAsString()
.- Returns:
- The packaging type of the app block.
- See Also:
-
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 becomesACTIVE
.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 returnAppBlockState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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 becomesACTIVE
.Custom app blocks are always in the
ACTIVE
state and no action is required to use them. - See Also:
-
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 becomesACTIVE
.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 returnAppBlockState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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 becomesACTIVE
.Custom app blocks are always in the
ACTIVE
state and no action is required to use them. - See Also:
-
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 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. -
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
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 interfaceToCopyableBuilder<AppBlock.Builder,
AppBlock> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-