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:

  • Method Details

    • 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. The lastEventTime value 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. The lastEventTime value 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 UTC The lastIngestionTime value 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 UTC The lastIngestionTime value 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 PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don't need to obtain uploadSequenceToken to use a PutLogEvents action.

      Returns:
      The sequence token.

      The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don't need to obtain uploadSequenceToken to use a PutLogEvents action.

    • 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 storedBytes parameter 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 storedBytes parameter for log groups is not affected.

    • toBuilder

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

    • builder

      public static LogStream.Builder builder()

    • serializableBuilderClass

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