software.amazon.awssdk.services.appstream.model.Fleet Maven / Gradle / Ivy
Show all versions of appstream Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.appstream.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Describes a fleet.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Fleet implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(Fleet::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Fleet::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DisplayName").getter(getter(Fleet::displayName)).setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisplayName").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(Fleet::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField IMAGE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ImageName").getter(getter(Fleet::imageName)).setter(setter(Builder::imageName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ImageName").build()).build();
private static final SdkField IMAGE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ImageArn").getter(getter(Fleet::imageArn)).setter(setter(Builder::imageArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ImageArn").build()).build();
private static final SdkField INSTANCE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceType").getter(getter(Fleet::instanceType)).setter(setter(Builder::instanceType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceType").build()).build();
private static final SdkField FLEET_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FleetType").getter(getter(Fleet::fleetTypeAsString)).setter(setter(Builder::fleetType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FleetType").build()).build();
private static final SdkField COMPUTE_CAPACITY_STATUS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ComputeCapacityStatus")
.getter(getter(Fleet::computeCapacityStatus)).setter(setter(Builder::computeCapacityStatus))
.constructor(ComputeCapacityStatus::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ComputeCapacityStatus").build())
.build();
private static final SdkField MAX_USER_DURATION_IN_SECONDS_FIELD = SdkField
. builder(MarshallingType.INTEGER).memberName("MaxUserDurationInSeconds")
.getter(getter(Fleet::maxUserDurationInSeconds)).setter(setter(Builder::maxUserDurationInSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxUserDurationInSeconds").build())
.build();
private static final SdkField DISCONNECT_TIMEOUT_IN_SECONDS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("DisconnectTimeoutInSeconds")
.getter(getter(Fleet::disconnectTimeoutInSeconds))
.setter(setter(Builder::disconnectTimeoutInSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisconnectTimeoutInSeconds").build())
.build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(Fleet::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField VPC_CONFIG_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("VpcConfig").getter(getter(Fleet::vpcConfig)).setter(setter(Builder::vpcConfig))
.constructor(VpcConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcConfig").build()).build();
private static final SdkField CREATED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreatedTime").getter(getter(Fleet::createdTime)).setter(setter(Builder::createdTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedTime").build()).build();
private static final SdkField> FLEET_ERRORS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("FleetErrors")
.getter(getter(Fleet::fleetErrors))
.setter(setter(Builder::fleetErrors))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FleetErrors").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(FleetError::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ENABLE_DEFAULT_INTERNET_ACCESS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("EnableDefaultInternetAccess")
.getter(getter(Fleet::enableDefaultInternetAccess))
.setter(setter(Builder::enableDefaultInternetAccess))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnableDefaultInternetAccess")
.build()).build();
private static final SdkField DOMAIN_JOIN_INFO_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DomainJoinInfo")
.getter(getter(Fleet::domainJoinInfo)).setter(setter(Builder::domainJoinInfo)).constructor(DomainJoinInfo::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainJoinInfo").build()).build();
private static final SdkField IDLE_DISCONNECT_TIMEOUT_IN_SECONDS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("IdleDisconnectTimeoutInSeconds")
.getter(getter(Fleet::idleDisconnectTimeoutInSeconds))
.setter(setter(Builder::idleDisconnectTimeoutInSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IdleDisconnectTimeoutInSeconds")
.build()).build();
private static final SdkField IAM_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IamRoleArn").getter(getter(Fleet::iamRoleArn)).setter(setter(Builder::iamRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IamRoleArn").build()).build();
private static final SdkField STREAM_VIEW_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StreamView").getter(getter(Fleet::streamViewAsString)).setter(setter(Builder::streamView))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamView").build()).build();
private static final SdkField PLATFORM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Platform").getter(getter(Fleet::platformAsString)).setter(setter(Builder::platform))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Platform").build()).build();
private static final SdkField MAX_CONCURRENT_SESSIONS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxConcurrentSessions").getter(getter(Fleet::maxConcurrentSessions))
.setter(setter(Builder::maxConcurrentSessions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxConcurrentSessions").build())
.build();
private static final SdkField> USB_DEVICE_FILTER_STRINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("UsbDeviceFilterStrings")
.getter(getter(Fleet::usbDeviceFilterStrings))
.setter(setter(Builder::usbDeviceFilterStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UsbDeviceFilterStrings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SESSION_SCRIPT_S3_LOCATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SessionScriptS3Location")
.getter(getter(Fleet::sessionScriptS3Location)).setter(setter(Builder::sessionScriptS3Location))
.constructor(S3Location::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SessionScriptS3Location").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, NAME_FIELD,
DISPLAY_NAME_FIELD, DESCRIPTION_FIELD, IMAGE_NAME_FIELD, IMAGE_ARN_FIELD, INSTANCE_TYPE_FIELD, FLEET_TYPE_FIELD,
COMPUTE_CAPACITY_STATUS_FIELD, MAX_USER_DURATION_IN_SECONDS_FIELD, DISCONNECT_TIMEOUT_IN_SECONDS_FIELD, STATE_FIELD,
VPC_CONFIG_FIELD, CREATED_TIME_FIELD, FLEET_ERRORS_FIELD, ENABLE_DEFAULT_INTERNET_ACCESS_FIELD,
DOMAIN_JOIN_INFO_FIELD, IDLE_DISCONNECT_TIMEOUT_IN_SECONDS_FIELD, IAM_ROLE_ARN_FIELD, STREAM_VIEW_FIELD,
PLATFORM_FIELD, MAX_CONCURRENT_SESSIONS_FIELD, USB_DEVICE_FILTER_STRINGS_FIELD, SESSION_SCRIPT_S3_LOCATION_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final String name;
private final String displayName;
private final String description;
private final String imageName;
private final String imageArn;
private final String instanceType;
private final String fleetType;
private final ComputeCapacityStatus computeCapacityStatus;
private final Integer maxUserDurationInSeconds;
private final Integer disconnectTimeoutInSeconds;
private final String state;
private final VpcConfig vpcConfig;
private final Instant createdTime;
private final List fleetErrors;
private final Boolean enableDefaultInternetAccess;
private final DomainJoinInfo domainJoinInfo;
private final Integer idleDisconnectTimeoutInSeconds;
private final String iamRoleArn;
private final String streamView;
private final String platform;
private final Integer maxConcurrentSessions;
private final List usbDeviceFilterStrings;
private final S3Location sessionScriptS3Location;
private Fleet(BuilderImpl builder) {
this.arn = builder.arn;
this.name = builder.name;
this.displayName = builder.displayName;
this.description = builder.description;
this.imageName = builder.imageName;
this.imageArn = builder.imageArn;
this.instanceType = builder.instanceType;
this.fleetType = builder.fleetType;
this.computeCapacityStatus = builder.computeCapacityStatus;
this.maxUserDurationInSeconds = builder.maxUserDurationInSeconds;
this.disconnectTimeoutInSeconds = builder.disconnectTimeoutInSeconds;
this.state = builder.state;
this.vpcConfig = builder.vpcConfig;
this.createdTime = builder.createdTime;
this.fleetErrors = builder.fleetErrors;
this.enableDefaultInternetAccess = builder.enableDefaultInternetAccess;
this.domainJoinInfo = builder.domainJoinInfo;
this.idleDisconnectTimeoutInSeconds = builder.idleDisconnectTimeoutInSeconds;
this.iamRoleArn = builder.iamRoleArn;
this.streamView = builder.streamView;
this.platform = builder.platform;
this.maxConcurrentSessions = builder.maxConcurrentSessions;
this.usbDeviceFilterStrings = builder.usbDeviceFilterStrings;
this.sessionScriptS3Location = builder.sessionScriptS3Location;
}
/**
*
* The Amazon Resource Name (ARN) for the fleet.
*
*
* @return The Amazon Resource Name (ARN) for the fleet.
*/
public final String arn() {
return arn;
}
/**
*
* The name of the fleet.
*
*
* @return The name of the fleet.
*/
public final String name() {
return name;
}
/**
*
* The fleet name to display.
*
*
* @return The fleet name to display.
*/
public final String displayName() {
return displayName;
}
/**
*
* The description to display.
*
*
* @return The description to display.
*/
public final String description() {
return description;
}
/**
*
* The name of the image used to create the fleet.
*
*
* @return The name of the image used to create the fleet.
*/
public final String imageName() {
return imageName;
}
/**
*
* The ARN for the public, private, or shared image.
*
*
* @return The ARN for the public, private, or shared image.
*/
public final String imageArn() {
return imageArn;
}
/**
*
* The instance type to use when launching fleet instances. The following instance types are available:
*
*
* -
*
* stream.standard.small
*
*
* -
*
* stream.standard.medium
*
*
* -
*
* stream.standard.large
*
*
* -
*
* stream.compute.large
*
*
* -
*
* stream.compute.xlarge
*
*
* -
*
* stream.compute.2xlarge
*
*
* -
*
* stream.compute.4xlarge
*
*
* -
*
* stream.compute.8xlarge
*
*
* -
*
* stream.memory.large
*
*
* -
*
* stream.memory.xlarge
*
*
* -
*
* stream.memory.2xlarge
*
*
* -
*
* stream.memory.4xlarge
*
*
* -
*
* stream.memory.8xlarge
*
*
* -
*
* stream.memory.z1d.large
*
*
* -
*
* stream.memory.z1d.xlarge
*
*
* -
*
* stream.memory.z1d.2xlarge
*
*
* -
*
* stream.memory.z1d.3xlarge
*
*
* -
*
* stream.memory.z1d.6xlarge
*
*
* -
*
* stream.memory.z1d.12xlarge
*
*
* -
*
* stream.graphics-design.large
*
*
* -
*
* stream.graphics-design.xlarge
*
*
* -
*
* stream.graphics-design.2xlarge
*
*
* -
*
* stream.graphics-design.4xlarge
*
*
* -
*
* stream.graphics-desktop.2xlarge
*
*
* -
*
* stream.graphics.g4dn.xlarge
*
*
* -
*
* stream.graphics.g4dn.2xlarge
*
*
* -
*
* stream.graphics.g4dn.4xlarge
*
*
* -
*
* stream.graphics.g4dn.8xlarge
*
*
* -
*
* stream.graphics.g4dn.12xlarge
*
*
* -
*
* stream.graphics.g4dn.16xlarge
*
*
* -
*
* stream.graphics-pro.4xlarge
*
*
* -
*
* stream.graphics-pro.8xlarge
*
*
* -
*
* stream.graphics-pro.16xlarge
*
*
*
*
* @return The instance type to use when launching fleet instances. The following instance types are available:
*
* -
*
* stream.standard.small
*
*
* -
*
* stream.standard.medium
*
*
* -
*
* stream.standard.large
*
*
* -
*
* stream.compute.large
*
*
* -
*
* stream.compute.xlarge
*
*
* -
*
* stream.compute.2xlarge
*
*
* -
*
* stream.compute.4xlarge
*
*
* -
*
* stream.compute.8xlarge
*
*
* -
*
* stream.memory.large
*
*
* -
*
* stream.memory.xlarge
*
*
* -
*
* stream.memory.2xlarge
*
*
* -
*
* stream.memory.4xlarge
*
*
* -
*
* stream.memory.8xlarge
*
*
* -
*
* stream.memory.z1d.large
*
*
* -
*
* stream.memory.z1d.xlarge
*
*
* -
*
* stream.memory.z1d.2xlarge
*
*
* -
*
* stream.memory.z1d.3xlarge
*
*
* -
*
* stream.memory.z1d.6xlarge
*
*
* -
*
* stream.memory.z1d.12xlarge
*
*
* -
*
* stream.graphics-design.large
*
*
* -
*
* stream.graphics-design.xlarge
*
*
* -
*
* stream.graphics-design.2xlarge
*
*
* -
*
* stream.graphics-design.4xlarge
*
*
* -
*
* stream.graphics-desktop.2xlarge
*
*
* -
*
* stream.graphics.g4dn.xlarge
*
*
* -
*
* stream.graphics.g4dn.2xlarge
*
*
* -
*
* stream.graphics.g4dn.4xlarge
*
*
* -
*
* stream.graphics.g4dn.8xlarge
*
*
* -
*
* stream.graphics.g4dn.12xlarge
*
*
* -
*
* stream.graphics.g4dn.16xlarge
*
*
* -
*
* stream.graphics-pro.4xlarge
*
*
* -
*
* stream.graphics-pro.8xlarge
*
*
* -
*
* stream.graphics-pro.16xlarge
*
*
*/
public final String instanceType() {
return instanceType;
}
/**
*
* The fleet type.
*
*
* - ALWAYS_ON
* -
*
* Provides users with instant-on access to their apps. You are charged for all running instances in your fleet,
* even if no users are streaming apps.
*
*
* - ON_DEMAND
* -
*
* Provide users with access to applications after they connect, which takes one to two minutes. You are charged for
* instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #fleetType} will
* return {@link FleetType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #fleetTypeAsString}.
*
*
* @return The fleet type.
*
* - ALWAYS_ON
* -
*
* Provides users with instant-on access to their apps. You are charged for all running instances in your
* fleet, even if no users are streaming apps.
*
*
* - ON_DEMAND
* -
*
* Provide users with access to applications after they connect, which takes one to two minutes. You are
* charged for instance streaming when users are connected and a small hourly fee for instances that are not
* streaming apps.
*
*
* @see FleetType
*/
public final FleetType fleetType() {
return FleetType.fromValue(fleetType);
}
/**
*
* The fleet type.
*
*
* - ALWAYS_ON
* -
*
* Provides users with instant-on access to their apps. You are charged for all running instances in your fleet,
* even if no users are streaming apps.
*
*
* - ON_DEMAND
* -
*
* Provide users with access to applications after they connect, which takes one to two minutes. You are charged for
* instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #fleetType} will
* return {@link FleetType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #fleetTypeAsString}.
*
*
* @return The fleet type.
*
* - ALWAYS_ON
* -
*
* Provides users with instant-on access to their apps. You are charged for all running instances in your
* fleet, even if no users are streaming apps.
*
*
* - ON_DEMAND
* -
*
* Provide users with access to applications after they connect, which takes one to two minutes. You are
* charged for instance streaming when users are connected and a small hourly fee for instances that are not
* streaming apps.
*
*
* @see FleetType
*/
public final String fleetTypeAsString() {
return fleetType;
}
/**
*
* The capacity status for the fleet.
*
*
* @return The capacity status for the fleet.
*/
public final ComputeCapacityStatus computeCapacityStatus() {
return computeCapacityStatus;
}
/**
*
* The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected
* to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents
* before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
*
*
* Specify a value between 600 and 360000.
*
*
* @return The maximum amount of time that a streaming session can remain active, in seconds. If users are still
* connected to a streaming instance five minutes before this limit is reached, they are prompted to save
* any open documents before being disconnected. After this time elapses, the instance is terminated and
* replaced by a new instance.
*
* Specify a value between 600 and 360000.
*/
public final Integer maxUserDurationInSeconds() {
return maxUserDurationInSeconds;
}
/**
*
* The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to
* the streaming session after a disconnection or network interruption within this time interval, they are connected
* to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
*
*
* Specify a value between 60 and 360000.
*
*
* @return The amount of time that a streaming session remains active after users disconnect. If they try to
* reconnect to the streaming session after a disconnection or network interruption within this time
* interval, they are connected to their previous session. Otherwise, they are connected to a new session
* with a new streaming instance.
*
* Specify a value between 60 and 360000.
*/
public final Integer disconnectTimeoutInSeconds() {
return disconnectTimeoutInSeconds;
}
/**
*
* The current state for the fleet.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link FleetState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state for the fleet.
* @see FleetState
*/
public final FleetState state() {
return FleetState.fromValue(state);
}
/**
*
* The current state for the fleet.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link FleetState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state for the fleet.
* @see FleetState
*/
public final String stateAsString() {
return state;
}
/**
*
* The VPC configuration for the fleet.
*
*
* @return The VPC configuration for the fleet.
*/
public final VpcConfig vpcConfig() {
return vpcConfig;
}
/**
*
* The time the fleet was created.
*
*
* @return The time the fleet was created.
*/
public final Instant createdTime() {
return createdTime;
}
/**
* For responses, this returns true if the service returned a value for the FleetErrors property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasFleetErrors() {
return fleetErrors != null && !(fleetErrors instanceof SdkAutoConstructList);
}
/**
*
* The fleet errors.
*
*
* 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 {@link #hasFleetErrors} method.
*
*
* @return The fleet errors.
*/
public final List fleetErrors() {
return fleetErrors;
}
/**
*
* Indicates whether default internet access is enabled for the fleet.
*
*
* @return Indicates whether default internet access is enabled for the fleet.
*/
public final Boolean enableDefaultInternetAccess() {
return enableDefaultInternetAccess;
}
/**
*
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory
* domain.
*
*
* @return The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active
* Directory domain.
*/
public final DomainJoinInfo domainJoinInfo() {
return domainJoinInfo;
}
/**
*
* The amount of time that users can be idle (inactive) before they are disconnected from their streaming session
* and the DisconnectTimeoutInSeconds
time interval begins. Users are notified before they are
* disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval
* specified in DisconnectTimeoutInSeconds
elapses, they are connected to their previous session. Users
* are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads
* and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be
* idle after the time interval in IdleDisconnectTimeoutInSeconds
elapses, they are disconnected.
*
*
* To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value
* between 60 and 3600. The default value is 0.
*
*
*
* If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of
* minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For
* example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a
* value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify
* a value of 90, users are disconnected after 2 minutes of inactivity.
*
*
*
* @return The amount of time that users can be idle (inactive) before they are disconnected from their streaming
* session and the DisconnectTimeoutInSeconds
time interval begins. Users are notified before
* they are disconnected due to inactivity. If users try to reconnect to the streaming session before the
* time interval specified in DisconnectTimeoutInSeconds
elapses, they are connected to their
* previous session. Users are considered idle when they stop providing keyboard or mouse input during their
* streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as
* user activity. If users continue to be idle after the time interval in
* IdleDisconnectTimeoutInSeconds
elapses, they are disconnected.
*
* To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a
* value between 60 and 3600. The default value is 0.
*
*
*
* If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole
* number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the
* nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of
* inactivity. If you specify a value that is at the midpoint between two different minutes, the value is
* rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of
* inactivity.
*
*/
public final Integer idleDisconnectTimeoutInSeconds() {
return idleDisconnectTimeoutInSeconds;
}
/**
*
* The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security
* Token Service (STS) AssumeRole
API operation and passes the ARN of the role to use. The operation
* creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates
* the appstream_machine_role credential profile on the instance.
*
*
* For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming
* Instances in the Amazon AppStream 2.0 Administration Guide.
*
*
* @return The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS
* Security Token Service (STS) AssumeRole
API operation and passes the ARN of the role to use.
* The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary
* credentials and creates the appstream_machine_role credential profile on the instance.
*
* For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming
* Instances in the Amazon AppStream 2.0 Administration Guide.
*/
public final String iamRoleArn() {
return iamRoleArn;
}
/**
*
* The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP
is
* specified, only the windows of applications opened by users display. When DESKTOP
is specified, the
* standard desktop that is provided by the operating system displays.
*
*
* The default value is APP
.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #streamView} will
* return {@link StreamView#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #streamViewAsString}.
*
*
* @return The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When
* APP
is specified, only the windows of applications opened by users display. When
* DESKTOP
is specified, the standard desktop that is provided by the operating system
* displays.
*
* The default value is APP
.
* @see StreamView
*/
public final StreamView streamView() {
return StreamView.fromValue(streamView);
}
/**
*
* The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP
is
* specified, only the windows of applications opened by users display. When DESKTOP
is specified, the
* standard desktop that is provided by the operating system displays.
*
*
* The default value is APP
.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #streamView} will
* return {@link StreamView#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #streamViewAsString}.
*
*
* @return The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When
* APP
is specified, only the windows of applications opened by users display. When
* DESKTOP
is specified, the standard desktop that is provided by the operating system
* displays.
*
* The default value is APP
.
* @see StreamView
*/
public final String streamViewAsString() {
return streamView;
}
/**
*
* The platform of the fleet.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #platform} will
* return {@link PlatformType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #platformAsString}.
*
*
* @return The platform of the fleet.
* @see PlatformType
*/
public final PlatformType platform() {
return PlatformType.fromValue(platform);
}
/**
*
* The platform of the fleet.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #platform} will
* return {@link PlatformType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #platformAsString}.
*
*
* @return The platform of the fleet.
* @see PlatformType
*/
public final String platformAsString() {
return platform;
}
/**
*
* The maximum number of concurrent sessions for the fleet.
*
*
* @return The maximum number of concurrent sessions for the fleet.
*/
public final Integer maxConcurrentSessions() {
return maxConcurrentSessions;
}
/**
* For responses, this returns true if the service returned a value for the UsbDeviceFilterStrings property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasUsbDeviceFilterStrings() {
return usbDeviceFilterStrings != null && !(usbDeviceFilterStrings instanceof SdkAutoConstructList);
}
/**
*
* The USB device filter strings associated with the fleet.
*
*
* 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 {@link #hasUsbDeviceFilterStrings} method.
*
*
* @return The USB device filter strings associated with the fleet.
*/
public final List usbDeviceFilterStrings() {
return usbDeviceFilterStrings;
}
/**
*
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*
*
* @return The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*/
public final S3Location sessionScriptS3Location() {
return sessionScriptS3Location;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(imageName());
hashCode = 31 * hashCode + Objects.hashCode(imageArn());
hashCode = 31 * hashCode + Objects.hashCode(instanceType());
hashCode = 31 * hashCode + Objects.hashCode(fleetTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(computeCapacityStatus());
hashCode = 31 * hashCode + Objects.hashCode(maxUserDurationInSeconds());
hashCode = 31 * hashCode + Objects.hashCode(disconnectTimeoutInSeconds());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(vpcConfig());
hashCode = 31 * hashCode + Objects.hashCode(createdTime());
hashCode = 31 * hashCode + Objects.hashCode(hasFleetErrors() ? fleetErrors() : null);
hashCode = 31 * hashCode + Objects.hashCode(enableDefaultInternetAccess());
hashCode = 31 * hashCode + Objects.hashCode(domainJoinInfo());
hashCode = 31 * hashCode + Objects.hashCode(idleDisconnectTimeoutInSeconds());
hashCode = 31 * hashCode + Objects.hashCode(iamRoleArn());
hashCode = 31 * hashCode + Objects.hashCode(streamViewAsString());
hashCode = 31 * hashCode + Objects.hashCode(platformAsString());
hashCode = 31 * hashCode + Objects.hashCode(maxConcurrentSessions());
hashCode = 31 * hashCode + Objects.hashCode(hasUsbDeviceFilterStrings() ? usbDeviceFilterStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(sessionScriptS3Location());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Fleet)) {
return false;
}
Fleet other = (Fleet) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name())
&& Objects.equals(displayName(), other.displayName()) && Objects.equals(description(), other.description())
&& Objects.equals(imageName(), other.imageName()) && Objects.equals(imageArn(), other.imageArn())
&& Objects.equals(instanceType(), other.instanceType())
&& Objects.equals(fleetTypeAsString(), other.fleetTypeAsString())
&& Objects.equals(computeCapacityStatus(), other.computeCapacityStatus())
&& Objects.equals(maxUserDurationInSeconds(), other.maxUserDurationInSeconds())
&& Objects.equals(disconnectTimeoutInSeconds(), other.disconnectTimeoutInSeconds())
&& Objects.equals(stateAsString(), other.stateAsString()) && Objects.equals(vpcConfig(), other.vpcConfig())
&& Objects.equals(createdTime(), other.createdTime()) && hasFleetErrors() == other.hasFleetErrors()
&& Objects.equals(fleetErrors(), other.fleetErrors())
&& Objects.equals(enableDefaultInternetAccess(), other.enableDefaultInternetAccess())
&& Objects.equals(domainJoinInfo(), other.domainJoinInfo())
&& Objects.equals(idleDisconnectTimeoutInSeconds(), other.idleDisconnectTimeoutInSeconds())
&& Objects.equals(iamRoleArn(), other.iamRoleArn())
&& Objects.equals(streamViewAsString(), other.streamViewAsString())
&& Objects.equals(platformAsString(), other.platformAsString())
&& Objects.equals(maxConcurrentSessions(), other.maxConcurrentSessions())
&& hasUsbDeviceFilterStrings() == other.hasUsbDeviceFilterStrings()
&& Objects.equals(usbDeviceFilterStrings(), other.usbDeviceFilterStrings())
&& Objects.equals(sessionScriptS3Location(), other.sessionScriptS3Location());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Fleet").add("Arn", arn()).add("Name", name()).add("DisplayName", displayName())
.add("Description", description()).add("ImageName", imageName()).add("ImageArn", imageArn())
.add("InstanceType", instanceType()).add("FleetType", fleetTypeAsString())
.add("ComputeCapacityStatus", computeCapacityStatus())
.add("MaxUserDurationInSeconds", maxUserDurationInSeconds())
.add("DisconnectTimeoutInSeconds", disconnectTimeoutInSeconds()).add("State", stateAsString())
.add("VpcConfig", vpcConfig()).add("CreatedTime", createdTime())
.add("FleetErrors", hasFleetErrors() ? fleetErrors() : null)
.add("EnableDefaultInternetAccess", enableDefaultInternetAccess()).add("DomainJoinInfo", domainJoinInfo())
.add("IdleDisconnectTimeoutInSeconds", idleDisconnectTimeoutInSeconds()).add("IamRoleArn", iamRoleArn())
.add("StreamView", streamViewAsString()).add("Platform", platformAsString())
.add("MaxConcurrentSessions", maxConcurrentSessions())
.add("UsbDeviceFilterStrings", hasUsbDeviceFilterStrings() ? usbDeviceFilterStrings() : null)
.add("SessionScriptS3Location", sessionScriptS3Location()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "DisplayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "ImageName":
return Optional.ofNullable(clazz.cast(imageName()));
case "ImageArn":
return Optional.ofNullable(clazz.cast(imageArn()));
case "InstanceType":
return Optional.ofNullable(clazz.cast(instanceType()));
case "FleetType":
return Optional.ofNullable(clazz.cast(fleetTypeAsString()));
case "ComputeCapacityStatus":
return Optional.ofNullable(clazz.cast(computeCapacityStatus()));
case "MaxUserDurationInSeconds":
return Optional.ofNullable(clazz.cast(maxUserDurationInSeconds()));
case "DisconnectTimeoutInSeconds":
return Optional.ofNullable(clazz.cast(disconnectTimeoutInSeconds()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "VpcConfig":
return Optional.ofNullable(clazz.cast(vpcConfig()));
case "CreatedTime":
return Optional.ofNullable(clazz.cast(createdTime()));
case "FleetErrors":
return Optional.ofNullable(clazz.cast(fleetErrors()));
case "EnableDefaultInternetAccess":
return Optional.ofNullable(clazz.cast(enableDefaultInternetAccess()));
case "DomainJoinInfo":
return Optional.ofNullable(clazz.cast(domainJoinInfo()));
case "IdleDisconnectTimeoutInSeconds":
return Optional.ofNullable(clazz.cast(idleDisconnectTimeoutInSeconds()));
case "IamRoleArn":
return Optional.ofNullable(clazz.cast(iamRoleArn()));
case "StreamView":
return Optional.ofNullable(clazz.cast(streamViewAsString()));
case "Platform":
return Optional.ofNullable(clazz.cast(platformAsString()));
case "MaxConcurrentSessions":
return Optional.ofNullable(clazz.cast(maxConcurrentSessions()));
case "UsbDeviceFilterStrings":
return Optional.ofNullable(clazz.cast(usbDeviceFilterStrings()));
case "SessionScriptS3Location":
return Optional.ofNullable(clazz.cast(sessionScriptS3Location()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function