Class QueryParameter

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.QueryParameter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QueryParameter.Builder,QueryParameter>
@Generated("software.amazon.awssdk:codegen") public final class QueryParameter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QueryParameter.Builder,QueryParameter>

This structure defines a query parameter for a saved CloudWatch Logs Insights query definition. Query parameters are supported only for Logs Insights QL queries. They are placeholder variables that you can reference in a query string using the {{parameterName}} syntax. Each parameter can include a default value and a description.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the query parameter. A query parameter name must start with a letter or underscore, and contain only letters, digits, and underscores.

      Returns:
      The name of the query parameter. A query parameter name must start with a letter or underscore, and contain only letters, digits, and underscores.

    • defaultValue

      public final String defaultValue()

      The default value to use for this query parameter if no value is supplied at execution time.

      Returns:
      The default value to use for this query parameter if no value is supplied at execution time.

    • description

      public final String description()

      A description of the query parameter that explains its purpose or expected values.

      Returns:
      A description of the query parameter that explains its purpose or expected values.

    • toBuilder

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

    • builder

      public static QueryParameter.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.