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

Class QueryInfo

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.QueryInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QueryInfo.Builder,QueryInfo>

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

Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryInfo.Builder

Method Summary

Modifier and Type	Method	Description
static QueryInfo.Builder	builder()
Long	createTime()	The date and time that this query was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	logGroupName()	The name of the log group scanned by this query.
String	queryId()	The unique ID number of this query.
QueryLanguage	queryLanguage()	The query language used for this query.
String	queryLanguageAsString()	The query language used for this query.
String	queryString()	The query string used in this query.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryInfo.Builder>	serializableBuilderClass()
QueryStatus	status()	The status of this query.
String	statusAsString()	The status of this query.
QueryInfo.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

queryLanguage

public final QueryLanguage queryLanguage()

The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

If the service returns an enum value that is not available in the current SDK version, queryLanguage will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLanguageAsString().

Returns:

The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

See Also:

QueryLanguage

queryLanguageAsString

public final String queryLanguageAsString()

The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

If the service returns an enum value that is not available in the current SDK version, queryLanguage will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLanguageAsString().

Returns:

The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

See Also:

QueryLanguage

queryId

public final String queryId()

The unique ID number of this query.

Returns:

The unique ID number of this query.

queryString

public final String queryString()

The query string used in this query.

Returns:

The query string used in this query.

status

public final QueryStatus status()

The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

If the service returns an enum value that is not available in the current SDK version, status will return QueryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

See Also:

QueryStatus

statusAsString

public final String statusAsString()

The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

If the service returns an enum value that is not available in the current SDK version, status will return QueryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

See Also:

QueryStatus

createTime

public final Long createTime()

The date and time that this query was created.

Returns:

The date and time that this query was created.

logGroupName

public final String logGroupName()

The name of the log group scanned by this query.

Returns:

The name of the log group scanned by this query.

toBuilder

public QueryInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryInfo.Builder,QueryInfo>

builder

public static QueryInfo.Builder builder()

serializableBuilderClass

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