software.amazon.awssdk.services.cloudwatchlogs.model

Class DescribeQueriesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueriesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeQueriesRequest.Builder,DescribeQueriesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeQueriesRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<DescribeQueriesRequest.Builder,DescribeQueriesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeQueriesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeQueriesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	logGroupName() Limits the returned queries to only those for the specified log group.
Integer	maxResults() Limits the number of returned queries to the specified number.
String	nextToken() Returns the value of the NextToken property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeQueriesRequest.Builder>	serializableBuilderClass()
QueryStatus	status() Limits the returned queries to only those that have the specified status.
String	statusAsString() Limits the returned queries to only those that have the specified status.
DescribeQueriesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

logGroupName

public String logGroupName()

Limits the returned queries to only those for the specified log group.

Returns:

Limits the returned queries to only those for the specified log group.

status

public QueryStatus status()

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

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:

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

See Also:

QueryStatus

statusAsString

public String statusAsString()

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

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:

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

See Also:

QueryStatus

maxResults

public Integer maxResults()

Limits the number of returned queries to the specified number.

Returns:

Limits the number of returned queries to the specified number.

nextToken

public String nextToken()

Returns the value of the NextToken property for this object.

Returns:

The value of the NextToken property for this object.

toBuilder

public DescribeQueriesRequest.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<DescribeQueriesRequest.Builder,DescribeQueriesRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

Returns:

a builder for type T

builder

public static DescribeQueriesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.