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

Class LaunchProfile

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

A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs).

Studio administrators create launch profiles in the Nimble Studio console. Artists can use their launch profiles to launch an instance from the Nimble Studio portal. Each user’s launch profile defines how they can launch a streaming session. By default, studio admins can use all launch profiles.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      Returns:
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

    • createdAt

      public final Instant createdAt()

      The ISO timestamp in seconds for when the resource was created.

      Returns:
      The ISO timestamp in seconds for when the resource was created.

    • createdBy

      public final String createdBy()

      The user ID of the user that created the launch profile.

      Returns:
      The user ID of the user that created the launch profile.

    • description

      public final String description()

      A human-readable description of the launch profile.

      Returns:
      A human-readable description of the launch profile.

    • hasEc2SubnetIds

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

    • ec2SubnetIds

      public final List<String> ec2SubnetIds()

      Unique identifiers for a collection of EC2 subnets.

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

      Returns:
      Unique identifiers for a collection of EC2 subnets.

    • 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.

    • hasLaunchProfileProtocolVersions

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

    • launchProfileProtocolVersions

      public final List<String> launchProfileProtocolVersions()

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

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

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

    • name

      public final String name()

      A friendly name for the launch profile.

      Returns:
      A friendly name for the launch profile.

    • state

      public final LaunchProfileState state()

      The current state.

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

      Returns:
      The current state.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state.

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

      Returns:
      The current state.
      See Also:

    • statusCode

      public final LaunchProfileStatusCode statusCode()

      The status code.

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

      Returns:
      The status code.
      See Also:

    • statusCodeAsString

      public final String statusCodeAsString()

      The status code.

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

      Returns:
      The status code.
      See Also:

    • statusMessage

      public final String statusMessage()

      The status message for the launch profile.

      Returns:
      The status message for the launch profile.

    • streamConfiguration

      public final StreamConfiguration streamConfiguration()

      A configuration for a streaming session.

      Returns:
      A configuration for a streaming session.

    • hasStudioComponentIds

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

    • studioComponentIds

      public final List<String> studioComponentIds()

      Unique identifiers for a collection of studio components that can be used with this launch profile.

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

      Returns:
      Unique identifiers for a collection of studio components that can be used with this launch profile.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A collection of labels, in the form of key-value pairs, that apply to this resource.

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

      Returns:
      A collection of labels, in the form of key-value pairs, that apply to this resource.

    • updatedAt

      public final Instant updatedAt()

      The ISO timestamp in seconds for when the resource was updated.

      Returns:
      The ISO timestamp in seconds for when the resource was updated.

    • updatedBy

      public final String updatedBy()

      The user ID of the user that most recently updated the resource.

      Returns:
      The user ID of the user that most recently updated the resource.

    • hasValidationResults

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

    • validationResults

      public final List<ValidationResult> validationResults()

      The list of the latest validation results.

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

      Returns:
      The list of the latest validation results.

    • toBuilder

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

    • builder

      public static LaunchProfile.Builder builder()

    • serializableBuilderClass

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