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 end of the time range to query.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLogGroupNames() Returns true if the LogGroupNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	limit() The maximum number of log events to return in the query.
String	logGroupName() The log group on which to perform the query.
List<String>	logGroupNames() The list of log groups to be queried.
String	queryString() The query string to use.
List<SdkField<?>>	sdkFields()
static Class<? extends StartQueryRequest.Builder>	serializableBuilderClass()
Long	startTime() The beginning of the time range to query.
StartQueryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

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

logGroupName

public String logGroupName()

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

Returns:

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

hasLogGroupNames

public boolean hasLogGroupNames()

Returns true if the LogGroupNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

logGroupNames

public List<String> logGroupNames()

The list of log groups to be queried. You can include up to 20 log groups.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasLogGroupNames() to see if a value was sent in this field.

Returns:

The list of log groups to be queried. You can include up to 20 log groups.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

startTime

public Long startTime()

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

endTime

public Long endTime()

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. 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. The default is 1000.

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. The default is 1000.

toBuilder

public StartQueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartQueryRequest.Builder,StartQueryRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static StartQueryRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo