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

Class SessionFilter

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

Describes a filter for Session Manager information.

See Also:

  • Method Details

    • key

      public final SessionFilterKey key()

      The name of the filter.

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

      Returns:
      The name of the filter.
      See Also:

    • keyAsString

      public final String keyAsString()

      The name of the filter.

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

      Returns:
      The name of the filter.
      See Also:

    • value

      public final String value()

      The filter value. Valid values for each filter key are as follows:

      • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.

      • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.

      • Target: Specify a managed node to which session connections have been made.

      • Owner: Specify an Amazon Web Services user to see a list of sessions started by that user.

      • Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:

        • Connected

        • Connecting

        • Disconnected

        • Terminated

        • Terminating

        • Failed

      • SessionId: Specify a session ID to return details about the session.

      Returns:
      The filter value. Valid values for each filter key are as follows:

      • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.

      • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.

      • Target: Specify a managed node to which session connections have been made.

      • Owner: Specify an Amazon Web Services user to see a list of sessions started by that user.

      • Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:

        • Connected

        • Connecting

        • Disconnected

        • Terminated

        • Terminating

        • Failed

      • SessionId: Specify a session ID to return details about the session.

    • toBuilder

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

    • builder

      public static SessionFilter.Builder builder()

    • serializableBuilderClass

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