software.amazon.awssdk.services.appstream.model

Class Fleet

java.lang.Object

software.amazon.awssdk.services.appstream.model.Fleet

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Fleet.Builder,Fleet>

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

Contains the parameters for a fleet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Fleet.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN for the fleet.
static Fleet.Builder	builder()
ComputeCapacityStatus	computeCapacityStatus() The capacity status for the fleet.
Instant	createdTime() The time the fleet was created.
String	description() The description displayed to end users.
Integer	disconnectTimeoutInSeconds() The time after disconnection when a session is considered to have ended, in seconds.
String	displayName() The fleet name displayed to end users.
DomainJoinInfo	domainJoinInfo() The information needed for streaming instances to join a domain.
Boolean	enableDefaultInternetAccess() Indicates whether default internet access is enabled for the fleet.
boolean	equals(Object obj)
List<FleetError>	fleetErrors() The fleet errors.
FleetType	fleetType() Returns the value of the FleetType property for this object.
String	fleetTypeAsString() Returns the value of the FleetType property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageName() The image used by the fleet.
String	instanceType() The instance type to use when launching fleet instances.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Integer	maxUserDurationInSeconds() The maximum time that a streaming session can run, in seconds.
String	name() The name of the fleet.
static Class<? extends Fleet.Builder>	serializableBuilderClass()
FleetState	state() The current state for the fleet.
String	stateAsString() The current state for the fleet.
Fleet.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
VpcConfig	vpcConfig() The VPC configuration for the fleet.

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

arn

public String arn()

The ARN for the fleet.

Returns:

The ARN for the fleet.

name

public String name()

The name of the fleet.

Returns:

The name of the fleet.

displayName

public String displayName()

The fleet name displayed to end users.

Returns:

The fleet name displayed to end users.

description

public String description()

The description displayed to end users.

Returns:

The description displayed to end users.

imageName

public String imageName()

The image used by the fleet.

Returns:

The image used by the fleet.

instanceType

public String instanceType()

The instance type to use when launching fleet instances.

Returns:

The instance type to use when launching fleet instances.

fleetType

public FleetType fleetType()

Returns the value of the FleetType property for this object.

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

Returns:

The value of the FleetType property for this object.

See Also:

FleetType

fleetTypeAsString

public String fleetTypeAsString()

Returns the value of the FleetType property for this object.

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

Returns:

The value of the FleetType property for this object.

See Also:

FleetType

computeCapacityStatus

public ComputeCapacityStatus computeCapacityStatus()

The capacity status for the fleet.

Returns:

The capacity status for the fleet.

maxUserDurationInSeconds

public Integer maxUserDurationInSeconds()

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

Returns:

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

disconnectTimeoutInSeconds

public Integer disconnectTimeoutInSeconds()

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

Returns:

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

state

public FleetState state()

The current state for the fleet.

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

Returns:

The current state for the fleet.

See Also:

FleetState

stateAsString

public String stateAsString()

The current state for the fleet.

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

Returns:

The current state for the fleet.

See Also:

FleetState

vpcConfig

public VpcConfig vpcConfig()

The VPC configuration for the fleet.

Returns:

The VPC configuration for the fleet.

createdTime

public Instant createdTime()

The time the fleet was created.

Returns:

The time the fleet was created.

fleetErrors

public List<FleetError> fleetErrors()

The fleet errors.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The fleet errors.

enableDefaultInternetAccess

public Boolean enableDefaultInternetAccess()

Indicates whether default internet access is enabled for the fleet.

Returns:

Indicates whether default internet access is enabled for the fleet.

domainJoinInfo

public DomainJoinInfo domainJoinInfo()

The information needed for streaming instances to join a domain.

Returns:

The information needed for streaming instances to join a domain.

toBuilder

public Fleet.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<Fleet.Builder,Fleet>

Returns:

a builder for type T

builder

public static Fleet.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.