Class UpdateLaunchProfileRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.nimble.model.NimbleRequest
software.amazon.awssdk.services.nimble.model.UpdateLaunchProfileRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateLaunchProfileRequest.Builder,UpdateLaunchProfileRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateLaunchProfileRequest extends NimbleRequest implements ToCopyableBuilder<UpdateLaunchProfileRequest.Builder,UpdateLaunchProfileRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    • description

      public final String description()

      The description.

      Returns:
      The description.

    • 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()

      The name for the launch profile.

      Returns:
      The name for the launch profile.

    • streamConfiguration

      public final StreamConfigurationCreate 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.

    • studioId

      public final String studioId()

      The studio ID.

      Returns:
      The studio ID.

    • toBuilder

      public UpdateLaunchProfileRequest.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<UpdateLaunchProfileRequest.Builder,UpdateLaunchProfileRequest>
      Specified by:
      toBuilder in class NimbleRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateLaunchProfileRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateLaunchProfileRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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