com.amazonaws.services.internetmonitor.model

Class StartQueryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.internetmonitor.model.StartQueryRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartQueryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartQueryRequest()

Method Summary

Modifier and Type	Method and Description
StartQueryRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Date	getEndTime() The timestamp that is the end of the period that you want to retrieve data for with your query.
List<FilterParameter>	getFilterParameters() 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.
String	getLinkedAccountId() The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor.
String	getMonitorName() The name of the monitor to query.
String	getQueryType() The type of query to run.
Date	getStartTime() The timestamp that is the beginning of the period that you want to retrieve data for with your query.
int	hashCode()
void	setEndTime(Date endTime) The timestamp that is the end of the period that you want to retrieve data for with your query.
void	setFilterParameters(Collection<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.
void	setLinkedAccountId(String linkedAccountId) The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor.
void	setMonitorName(String monitorName) The name of the monitor to query.
void	setQueryType(String queryType) The type of query to run.
void	setStartTime(Date startTime) The timestamp that is the beginning of the period that you want to retrieve data for with your query.
String	toString() Returns a string representation of this object.
StartQueryRequest	withEndTime(Date endTime) The timestamp that is the end of the period that you want to retrieve data for with your query.
StartQueryRequest	withFilterParameters(Collection<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.
StartQueryRequest	withFilterParameters(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.
StartQueryRequest	withLinkedAccountId(String linkedAccountId) The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor.
StartQueryRequest	withMonitorName(String monitorName) The name of the monitor to query.
StartQueryRequest	withQueryType(QueryType queryType) The type of query to run.
StartQueryRequest	withQueryType(String queryType) The type of query to run.
StartQueryRequest	withStartTime(Date startTime) The timestamp that is the beginning of the period that you want to retrieve data for with your query.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartQueryRequest

public StartQueryRequest()

Method Detail

setMonitorName

public void setMonitorName(String monitorName)

The name of the monitor to query.

Parameters:

monitorName - The name of the monitor to query.

getMonitorName

public String getMonitorName()

The name of the monitor to query.

Returns:

The name of the monitor to query.

withMonitorName

public StartQueryRequest withMonitorName(String monitorName)

The name of the monitor to query.

Parameters:

monitorName - The name of the monitor to query.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTime

public void setStartTime(Date startTime)

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

Parameters:

startTime - The timestamp that is the beginning of the period that you want to retrieve data for with your query.

getStartTime

public Date getStartTime()

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.

withStartTime

public StartQueryRequest withStartTime(Date startTime)

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

Parameters:

startTime - The timestamp that is the beginning of the period that you want to retrieve data for with your query.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndTime

public void setEndTime(Date endTime)

The timestamp that is the end of the period that you want to retrieve data for with your query.

Parameters:

endTime - The timestamp that is the end of the period that you want to retrieve data for with your query.

getEndTime

public Date getEndTime()

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.

withEndTime

public StartQueryRequest withEndTime(Date endTime)

The timestamp that is the end of the period that you want to retrieve data for with your query.

Parameters:

endTime - The timestamp that is the end of the period that you want to retrieve data for with your query.

Returns:

Returns a reference to this object so that method calls can be chained together.

setQueryType

public void setQueryType(String 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.

Parameters:

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.

See Also:

QueryType

getQueryType

public String getQueryType()

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.

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

withQueryType

public StartQueryRequest withQueryType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryType

withQueryType

public StartQueryRequest withQueryType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryType

getFilterParameters

public List<FilterParameter> getFilterParameters()

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.

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.

setFilterParameters

public void setFilterParameters(Collection<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.

Parameters:

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.

withFilterParameters

public StartQueryRequest withFilterParameters(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.

NOTE: This method appends the values to the existing list (if any). Use setFilterParameters(java.util.Collection) or withFilterParameters(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilterParameters

public StartQueryRequest withFilterParameters(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLinkedAccountId

public void setLinkedAccountId(String linkedAccountId)

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

Parameters:

linkedAccountId - The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

getLinkedAccountId

public String getLinkedAccountId()

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

Returns:

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

withLinkedAccountId

public StartQueryRequest withLinkedAccountId(String linkedAccountId)

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

Parameters:

linkedAccountId - The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartQueryRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()