java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.internetmonitor.model.InternetMonitorRequest
    - - software.amazon.awssdk.services.internetmonitor.model.StartQueryRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartQueryRequest.Builder,StartQueryRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartQueryRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartQueryRequest.Builder`	`builder()`
`Instant`	`endTime()`	The timestamp that is the end of the period that you want to retrieve data for with your query.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FilterParameter>`	`filterParameters()`	The `FilterParameters` field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilterParameters()`	For responses, this returns true if the service returned a value for the FilterParameters property.
`int`	`hashCode()`
`String`	`monitorName()`	The name of the monitor to query.
`QueryType`	`queryType()`	The type of query to run.
`String`	`queryTypeAsString()`	The type of query to run.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartQueryRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The timestamp that is the beginning of the period that you want to retrieve data for with your 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
  - monitorName
```
public final String monitorName()
```
    The name of the monitor to query.
    
    Returns:
    
    The name of the monitor to query.
  - startTime
```
public final Instant startTime()
```
    The timestamp that is the beginning of the period that you want to retrieve data for with your query.
    
    Returns:
    
    The timestamp that is the beginning of the period that you want to retrieve data for with your query.
  - endTime
```
public final Instant endTime()
```
    The timestamp that is the end of the period that you want to retrieve data for with your query.
    
    Returns:
    
    The timestamp that is the end of the period that you want to retrieve data for with your query.
  - queryType
```
public final QueryType queryType()
```
    The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:
    
    MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.
    
    TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.
    
    TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.
    
    For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, queryType will return QueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryTypeAsString().
    Returns:
    
    The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:
    
    MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.
    
    TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.
    
    TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.
    
    For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
    
    See Also:
    
    QueryType
  - queryTypeAsString
```
public final String queryTypeAsString()
```
    The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:
    
    MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.
    
    TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.
    
    TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.
    
    For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, queryType will return QueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryTypeAsString().
    Returns:
    
    The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:
    
    MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.
    
    TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.
    
    TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.
    
    For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
    
    See Also:
    
    QueryType
  - hasFilterParameters
```
public final boolean hasFilterParameters()
```
    For responses, this returns true if the service returned a value for the FilterParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filterParameters
```
public final List<FilterParameter> filterParameters()
```
    The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.
    
    For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilterParameters() method.
    
    Returns:
    
    The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.
    
    For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
  - toBuilder
```
public StartQueryRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartQueryRequest.Builder,StartQueryRequest>
    
    Specified by:
    
    toBuilder in class InternetMonitorRequest
  - builder
```
public static StartQueryRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartQueryRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartQueryRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

monitorName

startTime

endTime

queryType

queryTypeAsString

hasFilterParameters

filterParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields