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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryParameter.Builder

Method Summary

Modifier and Type	Method	Description
static QueryParameter.Builder	builder()
String	defaultValue()	The default value to use for this query parameter if no value is supplied at execution time.
String	description()	A description of the query parameter that explains its purpose or expected values.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the query parameter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryParameter.Builder>	serializableBuilderClass()
QueryParameter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<QueryParameter.Builder,QueryParameter>

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)

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)

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