software.amazon.awssdk.services.cloudwatchlogs.model

Class StartQueryRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartQueryRequest.Builder,StartQueryRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartQueryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartQueryRequest.Builder	builder()
Long	endTime() The time to end this query, if it is still running.
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()
Integer	limit() The maximum number of log events to return in the query.
String	logGroupName() The log group on which to perform the query.
String	queryString() The query string to use.
List<SdkField<?>>	sdkFields()
static Class<? extends StartQueryRequest.Builder>	serializableBuilderClass()
Long	startTime() The time to start the query.
StartQueryRequest.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()

The log group on which to perform the query.

Returns:

The log group on which to perform the query.

startTime

public Long startTime()

The time to start the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

The time to start the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

endTime

public Long endTime()

The time to end this query, if it is still running. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

The time to end this query, if it is still running. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

queryString

public String queryString()

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

Returns:

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

limit

public Integer limit()

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned.

Returns:

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned.

toBuilder

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

Specified by:

toBuilder in class CloudWatchLogsRequest

Returns:

a builder for type T

builder

public static StartQueryRequest.Builder builder()

serializableBuilderClass

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