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

Class LiveTailSessionUpdate

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.LiveTailSessionUpdate

All Implemented Interfaces:

Serializable, SdkPojo, StartLiveTailResponseStream, ToCopyableBuilder<LiveTailSessionUpdate.Builder,LiveTailSessionUpdate>

Direct Known Subclasses:

DefaultSessionUpdate

@Generated("software.amazon.awssdk:codegen")
public class LiveTailSessionUpdate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LiveTailSessionUpdate.Builder,LiveTailSessionUpdate>, StartLiveTailResponseStream

This object contains the log events and metadata for a Live Tail session.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LiveTailSessionUpdate.Builder
protected static class	LiveTailSessionUpdate.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.cloudwatchlogs.model.StartLiveTailResponseStream

StartLiveTailResponseStream.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.cloudwatchlogs.model.StartLiveTailResponseStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LiveTailSessionUpdate(LiveTailSessionUpdate.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(StartLiveTailResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of LiveTailSessionUpdate.
static LiveTailSessionUpdate.Builder	builder()
LiveTailSessionUpdate	copy(Consumer<? super LiveTailSessionUpdate.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSessionResults()	For responses, this returns true if the service returned a value for the SessionResults property.
List<SdkField<?>>	sdkFields()
static Class<? extends LiveTailSessionUpdate.Builder>	serializableBuilderClass()
LiveTailSessionMetadata	sessionMetadata()	This object contains the session metadata for a Live Tail session.
List<LiveTailSessionLogEvent>	sessionResults()	An array, where each member of the array includes the information for one log event in the Live Tail session.
LiveTailSessionUpdate.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.cloudwatchlogs.model.StartLiveTailResponseStream

sdkEventType

Constructor Detail

LiveTailSessionUpdate

protected LiveTailSessionUpdate(LiveTailSessionUpdate.BuilderImpl builder)

Method Detail

sessionMetadata

public final LiveTailSessionMetadata sessionMetadata()

This object contains the session metadata for a Live Tail session.

Returns:

This object contains the session metadata for a Live Tail session.

hasSessionResults

public final boolean hasSessionResults()

For responses, this returns true if the service returned a value for the SessionResults 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.

sessionResults

public final List<LiveTailSessionLogEvent> sessionResults()

An array, where each member of the array includes the information for one log event in the Live Tail session.

A sessionResults array can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each sessionUpdate structure.

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

Returns:

An array, where each member of the array includes the information for one log event in the Live Tail session.

A sessionResults array can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each sessionUpdate structure.

toBuilder

public LiveTailSessionUpdate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LiveTailSessionUpdate.Builder,LiveTailSessionUpdate>

builder

public static LiveTailSessionUpdate.Builder builder()

serializableBuilderClass

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

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)

copy

public final LiveTailSessionUpdate copy(Consumer<? super LiveTailSessionUpdate.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<LiveTailSessionUpdate.Builder,LiveTailSessionUpdate>

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(StartLiveTailResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of LiveTailSessionUpdate.

Specified by:

accept in interface StartLiveTailResponseStream

Parameters:

visitor - Visitor to invoke.