Interface StartQueryPerformanceMonitorRequest.Builder

  • Method Details

    • monitorName

      The name of the performance monitor.

      Parameters:
      monitorName - The name of the performance monitor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startTime

      The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

      Parameters:
      startTime - The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endTime

      The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

      Parameters:
      endTime - The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • queryType

      The type of query that you want to create. Specify TOP_PATHS to return the top paths for the performance monitor.

      Parameters:
      queryType - The type of query that you want to create. Specify TOP_PATHS to return the top paths for the performance monitor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • queryType

      The type of query that you want to create. Specify TOP_PATHS to return the top paths for the performance monitor.

      Parameters:
      queryType - The type of query that you want to create. Specify TOP_PATHS to return the top paths for the performance monitor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • filterParameters

      The filters for the query, to return a subset of the top paths. For a TOP_PATHS query, you can filter on the following fields:

      • local_az_id: The Availability Zone ID of the local end of a path

      • remote_az_id: The Availability Zone ID of the remote end of a path

      • impact_level: The impact level of a path

      When you filter on impact_level, Network Flow Monitor compares the filter with the most severe impact level for the path over the time period of the query, and the traffic and round-trip time that Network Flow Monitor returns for each path still cover the full time period. Paths that have no impact data don't match an impact_level filter, including a NOT_EQUALS filter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.

      Parameters:
      filterParameters - The filters for the query, to return a subset of the top paths. For a TOP_PATHS query, you can filter on the following fields:

      • local_az_id: The Availability Zone ID of the local end of a path

      • remote_az_id: The Availability Zone ID of the remote end of a path

      • impact_level: The impact level of a path

      When you filter on impact_level, Network Flow Monitor compares the filter with the most severe impact level for the path over the time period of the query, and the traffic and round-trip time that Network Flow Monitor returns for each path still cover the full time period. Paths that have no impact data don't match an impact_level filter, including a NOT_EQUALS filter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.

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

      StartQueryPerformanceMonitorRequest.Builder filterParameters(FilterParameter... filterParameters)

      The filters for the query, to return a subset of the top paths. For a TOP_PATHS query, you can filter on the following fields:

      • local_az_id: The Availability Zone ID of the local end of a path

      • remote_az_id: The Availability Zone ID of the remote end of a path

      • impact_level: The impact level of a path

      When you filter on impact_level, Network Flow Monitor compares the filter with the most severe impact level for the path over the time period of the query, and the traffic and round-trip time that Network Flow Monitor returns for each path still cover the full time period. Paths that have no impact data don't match an impact_level filter, including a NOT_EQUALS filter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.

      Parameters:
      filterParameters - The filters for the query, to return a subset of the top paths. For a TOP_PATHS query, you can filter on the following fields:

      • local_az_id: The Availability Zone ID of the local end of a path

      • remote_az_id: The Availability Zone ID of the remote end of a path

      • impact_level: The impact level of a path

      When you filter on impact_level, Network Flow Monitor compares the filter with the most severe impact level for the path over the time period of the query, and the traffic and round-trip time that Network Flow Monitor returns for each path still cover the full time period. Paths that have no impact data don't match an impact_level filter, including a NOT_EQUALS filter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.

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

      The filters for the query, to return a subset of the top paths. For a TOP_PATHS query, you can filter on the following fields:

      • local_az_id: The Availability Zone ID of the local end of a path

      • remote_az_id: The Availability Zone ID of the remote end of a path

      • impact_level: The impact level of a path

      When you filter on impact_level, Network Flow Monitor compares the filter with the most severe impact level for the path over the time period of the query, and the traffic and round-trip time that Network Flow Monitor returns for each path still cover the full time period. Paths that have no impact data don't match an impact_level filter, including a NOT_EQUALS filter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.

      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<FilterParameter>).

      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:
    • limit

      The maximum number of top paths that you want the query to return.

      Parameters:
      limit - The maximum number of top paths that you want the query to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.