Interface StartQueryPerformanceMonitorRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<StartQueryPerformanceMonitorRequest.Builder,,StartQueryPerformanceMonitorRequest> NetworkFlowMonitorRequest.Builder,SdkBuilder<StartQueryPerformanceMonitorRequest.Builder,,StartQueryPerformanceMonitorRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
StartQueryPerformanceMonitorRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe timestamp that is the date and time end of the period that you want to retrieve results for with your query.filterParameters(Collection<FilterParameter> filterParameters) The filters for the query, to return a subset of the top paths.filterParameters(Consumer<FilterParameter.Builder>... filterParameters) The filters for the query, to return a subset of the top paths.filterParameters(FilterParameter... filterParameters) The filters for the query, to return a subset of the top paths.The maximum number of top paths that you want the query to return.monitorName(String monitorName) The name of the performance monitor.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The type of query that you want to create.queryType(PerformanceMonitorQueryType queryType) The type of query that you want to create.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.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
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_PATHSto return the top paths for the performance monitor.- Parameters:
queryType- The type of query that you want to create. SpecifyTOP_PATHSto 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_PATHSto return the top paths for the performance monitor.- Parameters:
queryType- The type of query that you want to create. SpecifyTOP_PATHSto 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
StartQueryPerformanceMonitorRequest.Builder filterParameters(Collection<FilterParameter> filterParameters) The filters for the query, to return a subset of the top paths. For a
TOP_PATHSquery, 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 animpact_levelfilter, including aNOT_EQUALSfilter. 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 aTOP_PATHSquery, 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 animpact_levelfilter, including aNOT_EQUALSfilter. 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_PATHSquery, 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 animpact_levelfilter, including aNOT_EQUALSfilter. 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 aTOP_PATHSquery, 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 animpact_levelfilter, including aNOT_EQUALSfilter. 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(Consumer<FilterParameter.Builder>... filterParameters) The filters for the query, to return a subset of the top paths. For a
TOP_PATHSquery, 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
This is a convenience method that creates an instance of theimpact_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 animpact_levelfilter, including aNOT_EQUALSfilter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.FilterParameter.Builderavoiding the need to create one manually viaFilterParameter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilterParameters(List<FilterParameter>).- Parameters:
filterParameters- a consumer that will call methods onFilterParameter.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
StartQueryPerformanceMonitorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartQueryPerformanceMonitorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-