java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.QueryDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QueryDefinition.Builder,QueryDefinition>

@Generated("software.amazon.awssdk:codegen") public final class QueryDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QueryDefinition.Builder,QueryDefinition>

This structure contains details about a saved CloudWatch Logs Insights query definition.

See Also:
  • Method Details

    • queryDefinitionId

      public final String queryDefinitionId()

      The unique ID of the query definition.

      Returns:
      The unique ID of the query definition.
    • name

      public final String name()

      The name of the query definition.

      Returns:
      The name of the query definition.
    • queryString

      public final String queryString()

      The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

      Returns:
      The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
    • lastModified

      public final Long lastModified()

      The date that the query definition was most recently modified.

      Returns:
      The date that the query definition was most recently modified.
    • hasLogGroupNames

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

      public final List<String> logGroupNames()

      If this query definition contains a list of log groups that it is limited to, that list appears here.

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

      Returns:
      If this query definition contains a list of log groups that it is limited to, that list appears here.
    • toBuilder

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

      public static QueryDefinition.Builder builder()
    • serializableBuilderClass

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