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

Class GetLogEventsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest
software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetLogEventsRequest.Builder,GetLogEventsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetLogEventsRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<GetLogEventsRequest.Builder,GetLogEventsRequest>

  • Method Details

    • logGroupName

      public final String logGroupName()

      The name of the log group.

      You must include either logGroupIdentifier or logGroupName, but not both.

      Returns:
      The name of the log group.

      You must include either logGroupIdentifier or logGroupName, but not both.

    • logGroupIdentifier

      public final String logGroupIdentifier()

      Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

      You must include either logGroupIdentifier or logGroupName, but not both.

      Returns:
      Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

      You must include either logGroupIdentifier or logGroupName, but not both.

    • logStreamName

      public final String logStreamName()

      The name of the log stream.

      Returns:
      The name of the log stream.

    • startTime

      public final Long startTime()

      The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

      Returns:
      The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

    • endTime

      public final Long endTime()

      The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

      Returns:
      The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

    • nextToken

      public final String nextToken()

      The token for the next set of items to return. (You received this token from a previous call.)

      Returns:
      The token for the next set of items to return. (You received this token from a previous call.)

    • limit

      public final Integer limit()

      The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

      Returns:
      The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

    • startFromHead

      public final Boolean startFromHead()

      If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

      If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

      Returns:
      If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

      If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

    • unmask

      public final Boolean unmask()

      Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

      To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

      Returns:
      Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

      To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

    • toBuilder

      public GetLogEventsRequest.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<GetLogEventsRequest.Builder,GetLogEventsRequest>
      Specified by:
      toBuilder in class CloudWatchLogsRequest
      Returns:
      a builder for type T

    • builder

      public static GetLogEventsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetLogEventsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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