Package software.amazon.awssdk.services.internetmonitor.model

Interface StartQueryRequest.Builder

    • Method Detail

      • monitorName

        StartQueryRequest.Builder monitorName​(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.

      • startTime

        StartQueryRequest.Builder startTime​(Instant 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.

      • endTime

        StartQueryRequest.Builder endTime​(Instant 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.

      • queryType

        StartQueryRequest.Builder queryType​(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, QueryType

      • queryType

        StartQueryRequest.Builder queryType​(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, QueryType

      • filterParameters

        StartQueryRequest.Builder filterParameters​(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.

      • filterParameters

        StartQueryRequest.Builder filterParameters​(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.

      • filterParameters

        StartQueryRequest.Builder filterParameters​(Consumer<FilterParameter.Builder>... 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.

        This is a convenience method that creates an instance of the FilterParameter.Builder avoiding the need to create one manually via FilterParameter.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filterParameters(List).

        Parameters:
        filterParameters - a consumer that will call methods on FilterParameter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #filterParameters(java.util.Collection)

      • linkedAccountId

        StartQueryRequest.Builder linkedAccountId​(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.