Package software.amazon.awssdk.services.appstream.model

Class Stack

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

Describes a stack.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the stack.

      Returns:
      The ARN of the stack.

    • name

      public final String name()

      The name of the stack.

      Returns:
      The name of the stack.

    • description

      public final String description()

      The description to display.

      Returns:
      The description to display.

    • displayName

      public final String displayName()

      The stack name to display.

      Returns:
      The stack name to display.

    • createdTime

      public final Instant createdTime()

      The time the stack was created.

      Returns:
      The time the stack was created.

    • hasStorageConnectors

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

    • storageConnectors

      public final List<StorageConnector> storageConnectors()

      The storage connectors to enable.

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

      Returns:
      The storage connectors to enable.

    • redirectURL

      public final String redirectURL()

      The URL that users are redirected to after their streaming session ends.

      Returns:
      The URL that users are redirected to after their streaming session ends.

    • feedbackURL

      public final String feedbackURL()

      The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

      Returns:
      The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

    • hasStackErrors

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

    • stackErrors

      public final List<StackError> stackErrors()

      The errors for the stack.

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

      Returns:
      The errors for the stack.

    • hasUserSettings

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

    • userSettings

      public final List<UserSetting> userSettings()

      The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

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

      Returns:
      The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

    • applicationSettings

      public final ApplicationSettingsResponse applicationSettings()

      The persistent application settings for users of the stack.

      Returns:
      The persistent application settings for users of the stack.

    • hasAccessEndpoints

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

    • accessEndpoints

      public final List<AccessEndpoint> accessEndpoints()

      The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

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

      Returns:
      The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

    • hasEmbedHostDomains

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

    • embedHostDomains

      public final List<String> embedHostDomains()

      The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

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

      Returns:
      The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

    • streamingExperienceSettings

      public final StreamingExperienceSettings streamingExperienceSettings()

      The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

      Returns:
      The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

    • toBuilder

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

    • builder

      public static Stack.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Stack.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.