Class CreateStreamingSessionRequest

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.CreateStreamingSessionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateStreamingSessionRequest.Builder,CreateStreamingSessionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateStreamingSessionRequest extends NimbleRequest implements ToCopyableBuilder<CreateStreamingSessionRequest.Builder,CreateStreamingSessionRequest>

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

    • ec2InstanceType

      public final StreamingInstanceType ec2InstanceType()

      The EC2 Instance type used for the streaming session.

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

      Returns:
      The EC2 Instance type used for the streaming session.
      See Also:

    • ec2InstanceTypeAsString

      public final String ec2InstanceTypeAsString()

      The EC2 Instance type used for the streaming session.

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

      Returns:
      The EC2 Instance type used for the streaming session.
      See Also:

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

    • ownedBy

      public final String ownedBy()

      The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      Returns:
      The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

    • streamingImageId

      public final String streamingImageId()

      The ID of the streaming image.

      Returns:
      The ID of the streaming image.

    • studioId

      public final String studioId()

      The studio ID.

      Returns:
      The studio ID.

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

    • toBuilder

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

    • builder

      public static CreateStreamingSessionRequest.Builder builder()

    • serializableBuilderClass

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