Package software.amazon.awssdk.services.nimble.model

Class LaunchProfileInitialization

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

A launch profile initialization contains information required for a workstation or server to connect to a launch profile.

This includes scripts, endpoints, security groups, subnets, and other configuration.

See Also:

  • Method Details

    • activeDirectory

      public final LaunchProfileInitializationActiveDirectory activeDirectory()

      A LaunchProfileInitializationActiveDirectory resource.

      Returns:
      A LaunchProfileInitializationActiveDirectory resource.

    • hasEc2SecurityGroupIds

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

    • ec2SecurityGroupIds

      public final List<String> ec2SecurityGroupIds()

      The EC2 security groups that control access to the studio component.

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

      Returns:
      The EC2 security groups that control access to the studio component.

    • launchProfileId

      public final String launchProfileId()

      The ID of the launch profile used to control access from the streaming session.

      Returns:
      The ID of the launch profile used to control access from the streaming session.

    • launchProfileProtocolVersion

      public final String launchProfileProtocolVersion()

      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

      Returns:
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

    • launchPurpose

      public final String launchPurpose()

      The launch purpose.

      Returns:
      The launch purpose.

    • name

      public final String name()

      The name for the launch profile.

      Returns:
      The name for the launch profile.

    • platform

      public final LaunchProfilePlatform platform()

      The platform of the launch platform, either Windows or Linux.

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

      Returns:
      The platform of the launch platform, either Windows or Linux.
      See Also:

    • platformAsString

      public final String platformAsString()

      The platform of the launch platform, either Windows or Linux.

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

      Returns:
      The platform of the launch platform, either Windows or Linux.
      See Also:

    • hasSystemInitializationScripts

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

    • systemInitializationScripts

      public final List<LaunchProfileInitializationScript> systemInitializationScripts()

      The system initializtion scripts.

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

      Returns:
      The system initializtion scripts.

    • hasUserInitializationScripts

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

    • userInitializationScripts

      public final List<LaunchProfileInitializationScript> userInitializationScripts()

      The user initializtion scripts.

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

      Returns:
      The user initializtion scripts.

    • toBuilder

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

    • builder

      public static LaunchProfileInitialization.Builder builder()

    • serializableBuilderClass

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