Class LogStream
- java.lang.Object
-
- software.amazon.awssdk.services.cloudwatchlogs.model.LogStream
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<LogStream.Builder,LogStream>
@Generated("software.amazon.awssdk:codegen") public final class LogStream extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LogStream.Builder,LogStream>
Represents a log stream, which is a sequence of log events from a single emitter of logs.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceLogStream.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the log stream.static LogStream.Builderbuilder()LongcreationTime()The creation time of the stream, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)LongfirstEventTimestamp()The time of the first event, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()LonglastEventTimestamp()The time of the most recent log event in the log stream in CloudWatch Logs.LonglastIngestionTime()The ingestion time, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTCThelastIngestionTimevalue updates on an eventual consistency basis.StringlogStreamName()The name of the log stream.List<SdkField<?>>sdkFields()static Class<? extends LogStream.Builder>serializableBuilderClass()LongstoredBytes()Deprecated.Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero.LogStream.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringuploadSequenceToken()The sequence token.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
logStreamName
public final String logStreamName()
The name of the log stream.
- Returns:
- The name of the log stream.
-
creationTime
public final Long creationTime()
The creation time of the stream, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC.- Returns:
- The creation time of the stream, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC.
-
firstEventTimestamp
public final Long firstEventTimestamp()
The time of the first event, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC.- Returns:
- The time of the first event, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC.
-
lastEventTimestamp
public final Long lastEventTimestamp()
The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC. ThelastEventTimevalue updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.- Returns:
- The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as
the number of milliseconds after
Jan 1, 1970 00:00:00 UTC. ThelastEventTimevalue updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.
-
lastIngestionTime
public final Long lastIngestionTime()
The ingestion time, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTCThelastIngestionTimevalue updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.- Returns:
- The ingestion time, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTCThelastIngestionTimevalue updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.
-
uploadSequenceToken
public final String uploadSequenceToken()
The sequence token.
The sequence token is now ignored in
PutLogEventsactions.PutLogEventsactions are always accepted regardless of receiving an invalid sequence token. You don't need to obtainuploadSequenceTokento use aPutLogEventsaction.- Returns:
- The sequence token.
The sequence token is now ignored in
PutLogEventsactions.PutLogEventsactions are always accepted regardless of receiving an invalid sequence token. You don't need to obtainuploadSequenceTokento use aPutLogEventsaction.
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the log stream.
- Returns:
- The Amazon Resource Name (ARN) of the log stream.
-
storedBytes
@Deprecated public final Long storedBytes()
Deprecated.Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.The number of bytes stored.
Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The
storedBytesparameter for log groups is not affected.- Returns:
- The number of bytes stored.
Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The
storedBytesparameter for log groups is not affected.
-
toBuilder
public LogStream.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<LogStream.Builder,LogStream>
-
builder
public static LogStream.Builder builder()
-
serializableBuilderClass
public static Class<? extends LogStream.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-