Package software.amazon.awssdk.services.ssm.model

Class DescribeSessionsRequest

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

  • Method Details

    • state

      public final SessionState state()

      The session status to retrieve a list of sessions for. For example, "Active".

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

      Returns:
      The session status to retrieve a list of sessions for. For example, "Active".
      See Also:

    • stateAsString

      public final String stateAsString()

      The session status to retrieve a list of sessions for. For example, "Active".

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

      Returns:
      The session status to retrieve a list of sessions for. For example, "Active".
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

      Returns:
      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • nextToken

      public final String nextToken()

      The token for the next set of items to return. (You received this token from a previous call.)

      Returns:
      The token for the next set of items to return. (You received this token from a previous call.)

    • hasFilters

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

    • filters

      public final List<SessionFilter> filters()

      One or more filters to limit the type of sessions returned by the request.

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

      Returns:
      One or more filters to limit the type of sessions returned by the request.

    • toBuilder

      public DescribeSessionsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>
      Specified by:
      toBuilder in class SsmRequest

    • builder

      public static DescribeSessionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeSessionsRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo