Package software.amazon.awssdk.services.cloudwatchlogs.model

Class LiveTailSessionStart

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.LiveTailSessionStart
All Implemented Interfaces:
Serializable, SdkPojo, StartLiveTailResponseStream, ToCopyableBuilder<LiveTailSessionStart.Builder,LiveTailSessionStart>
Direct Known Subclasses:
DefaultSessionStart
@Generated("software.amazon.awssdk:codegen") public class LiveTailSessionStart extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LiveTailSessionStart.Builder,LiveTailSessionStart>, StartLiveTailResponseStream

This object contains information about this Live Tail session, including the log groups included and the log stream filters, if any.

See Also:

  • Method Details

    • requestId

      public final String requestId()

      The unique ID generated by CloudWatch Logs to identify this Live Tail session request.

      Returns:
      The unique ID generated by CloudWatch Logs to identify this Live Tail session request.

    • sessionId

      public final String sessionId()

      The unique ID generated by CloudWatch Logs to identify this Live Tail session.

      Returns:
      The unique ID generated by CloudWatch Logs to identify this Live Tail session.

    • hasLogGroupIdentifiers

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

    • logGroupIdentifiers

      public final List<String> logGroupIdentifiers()

      An array of the names and ARNs of the log groups included in this Live Tail session.

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

      Returns:
      An array of the names and ARNs of the log groups included in this Live Tail session.

    • hasLogStreamNames

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

    • logStreamNames

      public final List<String> logStreamNames()

      If your StartLiveTail operation request included a logStreamNames parameter that filtered the session to only include certain log streams, these streams are listed here.

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

      Returns:
      If your StartLiveTail operation request included a logStreamNames parameter that filtered the session to only include certain log streams, these streams are listed here.

    • hasLogStreamNamePrefixes

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

    • logStreamNamePrefixes

      public final List<String> logStreamNamePrefixes()

      If your StartLiveTail operation request included a logStreamNamePrefixes parameter that filtered the session to only include log streams that have names that start with certain prefixes, these prefixes are listed here.

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

      Returns:
      If your StartLiveTail operation request included a logStreamNamePrefixes parameter that filtered the session to only include log streams that have names that start with certain prefixes, these prefixes are listed here.

    • logEventFilterPattern

      public final String logEventFilterPattern()

      An optional pattern to filter the results to include only log events that match the pattern. For example, a filter pattern of error 404 displays only log events that include both error and 404.

      For more information about filter pattern syntax, see Filter and Pattern Syntax.

      Returns:
      An optional pattern to filter the results to include only log events that match the pattern. For example, a filter pattern of error 404 displays only log events that include both error and 404.

      For more information about filter pattern syntax, see Filter and Pattern Syntax.

    • toBuilder

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

    • builder

      public static LiveTailSessionStart.Builder builder()

    • serializableBuilderClass

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

    • copy

      public final LiveTailSessionStart copy(Consumer<? super LiveTailSessionStart.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<LiveTailSessionStart.Builder,LiveTailSessionStart>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

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

    • accept

      public void accept(StartLiveTailResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of LiveTailSessionStart.
      Specified by:
      accept in interface StartLiveTailResponseStream
      Parameters:
      visitor - Visitor to invoke.