Class Environment

java.lang.Object
software.amazon.awssdk.services.workspacesthinclient.model.Environment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Environment.Builder,Environment>
@Generated("software.amazon.awssdk:codegen") public final class Environment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Environment.Builder,Environment>

Describes an environment.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the environment.

      Returns:
      The ID of the environment.

    • name

      public final String name()

      The name of the environment.

      Returns:
      The name of the environment.

    • desktopArn

      public final String desktopArn()

      The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

      Returns:
      The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

    • desktopEndpoint

      public final String desktopEndpoint()

      The URL for the identity provider login (only for environments that use AppStream 2.0).

      Returns:
      The URL for the identity provider login (only for environments that use AppStream 2.0).

    • desktopType

      public final DesktopType desktopType()

      The type of streaming desktop for the environment.

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

      Returns:
      The type of streaming desktop for the environment.
      See Also:

    • desktopTypeAsString

      public final String desktopTypeAsString()

      The type of streaming desktop for the environment.

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

      Returns:
      The type of streaming desktop for the environment.
      See Also:

    • activationCode

      public final String activationCode()

      The activation code to register a device to the environment.

      Returns:
      The activation code to register a device to the environment.

    • registeredDevicesCount

      public final Integer registeredDevicesCount()

      The number of devices registered to the environment.

      Returns:
      The number of devices registered to the environment.

    • softwareSetUpdateSchedule

      public final SoftwareSetUpdateSchedule softwareSetUpdateSchedule()

      An option to define if software updates should be applied within a maintenance window.

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

      Returns:
      An option to define if software updates should be applied within a maintenance window.
      See Also:

    • softwareSetUpdateScheduleAsString

      public final String softwareSetUpdateScheduleAsString()

      An option to define if software updates should be applied within a maintenance window.

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

      Returns:
      An option to define if software updates should be applied within a maintenance window.
      See Also:

    • maintenanceWindow

      public final MaintenanceWindow maintenanceWindow()

      A specification for a time window to apply software updates.

      Returns:
      A specification for a time window to apply software updates.

    • softwareSetUpdateMode

      public final SoftwareSetUpdateMode softwareSetUpdateMode()

      An option to define which software updates to apply.

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

      Returns:
      An option to define which software updates to apply.
      See Also:

    • softwareSetUpdateModeAsString

      public final String softwareSetUpdateModeAsString()

      An option to define which software updates to apply.

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

      Returns:
      An option to define which software updates to apply.
      See Also:

    • desiredSoftwareSetId

      public final String desiredSoftwareSetId()

      The ID of the software set to apply.

      Returns:
      The ID of the software set to apply.

    • pendingSoftwareSetId

      public final String pendingSoftwareSetId()

      The ID of the software set that is pending to be installed.

      Returns:
      The ID of the software set that is pending to be installed.

    • pendingSoftwareSetVersion

      public final String pendingSoftwareSetVersion()

      The version of the software set that is pending to be installed.

      Returns:
      The version of the software set that is pending to be installed.

    • softwareSetComplianceStatus

      public final EnvironmentSoftwareSetComplianceStatus softwareSetComplianceStatus()

      Describes if the software currently installed on all devices in the environment is a supported version.

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

      Returns:
      Describes if the software currently installed on all devices in the environment is a supported version.
      See Also:

    • softwareSetComplianceStatusAsString

      public final String softwareSetComplianceStatusAsString()

      Describes if the software currently installed on all devices in the environment is a supported version.

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

      Returns:
      Describes if the software currently installed on all devices in the environment is a supported version.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp of when the environment was created.

      Returns:
      The timestamp of when the environment was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp of when the device was updated.

      Returns:
      The timestamp of when the device was updated.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the environment.

      Returns:
      The Amazon Resource Name (ARN) of the environment.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.

      Returns:
      The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.

    • hasDeviceCreationTags

      public final boolean hasDeviceCreationTags()
      For responses, this returns true if the service returned a value for the DeviceCreationTags 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.

    • deviceCreationTags

      public final Map<String,String> deviceCreationTags()

      The tag keys and optional values for the newly created devices for this environment.

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

      Returns:
      The tag keys and optional values for the newly created devices for this environment.

    • toBuilder

      public Environment.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<Environment.Builder,Environment>
      Returns:
      a builder for type T

    • builder

      public static Environment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Environment.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.