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

Class FilterLogEventsRequest

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.FilterLogEventsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>
@Generated("software.amazon.awssdk:codegen") public final class FilterLogEventsRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>

  • Method Details

    • logGroupName

      public final String logGroupName()

      The name of the log group to search.

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

      Returns:
      The name of the log group to search.

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

    • 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()

      Filters the results to only logs from the log streams in this list.

      If you specify a value for both logStreamNames and logStreamNamePrefix, the action returns an InvalidParameterException error.

      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:
      Filters the results to only logs from the log streams in this list.

      If you specify a value for both logStreamNames and logStreamNamePrefix, the action returns an InvalidParameterException error.

    • logStreamNamePrefix

      public final String logStreamNamePrefix()

      Filters the results to include only events from log streams that have names starting with this prefix.

      If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

      Returns:
      Filters the results to include only events from log streams that have names starting with this prefix.

      If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

    • 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 before this time are not returned.

      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 before this time are not returned.

    • 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 later than this time are not returned.

      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 later than this time are not returned.

    • filterPattern

      public final String filterPattern()

      The filter pattern to use. For more information, see Filter and Pattern Syntax.

      If not provided, all the events are matched.

      Returns:
      The filter pattern to use. For more information, see Filter and Pattern Syntax.

      If not provided, all the events are matched.

    • nextToken

      public final String nextToken()

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

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

    • limit

      public final Integer limit()

      The maximum number of events to return. The default is 10,000 events.

      Returns:
      The maximum number of events to return. The default is 10,000 events.

    • interleaved

      @Deprecated public final Boolean interleaved()
      Deprecated.
      Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.

      If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

      Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

      Returns:
      If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

      Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

    • 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 FilterLogEventsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>
      Specified by:
      toBuilder in class CloudWatchLogsRequest

    • builder

      public static FilterLogEventsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FilterLogEventsRequest.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)
      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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo