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

Class FilterLogEventsResponse

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

  • Method Details

    • hasEvents

      public final boolean hasEvents()
      For responses, this returns true if the service returned a value for the Events 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.

    • events

      public final List<FilteredLogEvent> events()

      The matched events.

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

      Returns:
      The matched events.

    • hasSearchedLogStreams

      public final boolean hasSearchedLogStreams()
      For responses, this returns true if the service returned a value for the SearchedLogStreams 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.

    • searchedLogStreams

      public final List<SearchedLogStream> searchedLogStreams()

      Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.

      Indicates which log streams have been searched and whether each has been searched completely.

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

      Returns:
      Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.

      Indicates which log streams have been searched and whether each has been searched completely.

    • nextToken

      public final String nextToken()

      The token to use when requesting the next set of items. The token expires after 24 hours.

      If the results don't include a nextToken, then pagination is finished.

      Returns:
      The token to use when requesting the next set of items. The token expires after 24 hours.

      If the results don't include a nextToken, then pagination is finished.

    • toBuilder

      public FilterLogEventsResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<FilterLogEventsResponse.Builder,FilterLogEventsResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static FilterLogEventsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

    • 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