Class StartQueryPerformanceMonitorRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<StartQueryPerformanceMonitorRequest.Builder,StartQueryPerformanceMonitorRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final InstantendTime()The timestamp that is the date and time end of the period that you want to retrieve results for with your query.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List<FilterParameter> The filters for the query, to return a subset of the top paths.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final booleanFor responses, this returns true if the service returned a value for the FilterParameters property.final inthashCode()final Integerlimit()The maximum number of top paths that you want the query to return.final StringThe name of the performance monitor.The type of query that you want to create.final StringThe type of query that you want to create.static Class<? extends StartQueryPerformanceMonitorRequest.Builder> final InstantThe timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
monitorName
The name of the performance monitor.
- Returns:
- The name of the performance monitor.
-
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:
- 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.
-
endTime
The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
- Returns:
- The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
-
queryType
The type of query that you want to create. Specify
TOP_PATHSto return the top paths for the performance monitor.If the service returns an enum value that is not available in the current SDK version,
queryTypewill returnPerformanceMonitorQueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromqueryTypeAsString().- Returns:
- The type of query that you want to create. Specify
TOP_PATHSto return the top paths for the performance monitor. - See Also:
-
queryTypeAsString
The type of query that you want to create. Specify
TOP_PATHSto return the top paths for the performance monitor.If the service returns an enum value that is not available in the current SDK version,
queryTypewill returnPerformanceMonitorQueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromqueryTypeAsString().- Returns:
- The type of query that you want to create. Specify
TOP_PATHSto return the top paths for the performance monitor. - See Also:
-
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 theisEmpty()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
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.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 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. -
-
-
limit
The maximum number of top paths that you want the query to return.
- Returns:
- The maximum number of top paths that you want the query to return.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<StartQueryPerformanceMonitorRequest.Builder,StartQueryPerformanceMonitorRequest> - Specified by:
toBuilderin classNetworkFlowMonitorRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends StartQueryPerformanceMonitorRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-