Class StopStreamingSessionRequest

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

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

    • sessionId

      public final String sessionId()

      The streaming session ID for the StopStreamingSessionRequest.

      Returns:
      The streaming session ID for the StopStreamingSessionRequest.

    • studioId

      public final String studioId()

      The studioId for the StopStreamingSessionRequest.

      Returns:
      The studioId for the StopStreamingSessionRequest.

    • volumeRetentionMode

      public final VolumeRetentionMode volumeRetentionMode()

      Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.

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

      Returns:
      Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.
      See Also:

    • volumeRetentionModeAsString

      public final String volumeRetentionModeAsString()

      Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.

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

      Returns:
      Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.
      See Also:

    • toBuilder

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

    • builder

      public static StopStreamingSessionRequest.Builder builder()

    • serializableBuilderClass

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