Class StartQueryPerformanceMonitorRequest

  • Method Details

    • monitorName

      public final String monitorName()

      The name of the performance monitor.

      Returns:
      The name of the performance monitor.
    • startTime

      public final Instant 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

      public final Instant 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

      public final PerformanceMonitorQueryType queryType()

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

      If the service returns an enum value that is not available in the current SDK version, queryType will return PerformanceMonitorQueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryTypeAsString().

      Returns:
      The type of query that you want to create. Specify TOP_PATHS to return the top paths for the performance monitor.
      See Also:
    • queryTypeAsString

      public final String queryTypeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, queryType will return PerformanceMonitorQueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryTypeAsString().

      Returns:
      The type of query that you want to create. Specify TOP_PATHS to 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 the isEmpty() 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

      public final List<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.

      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_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.

    • limit

      public final Integer 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: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartQueryPerformanceMonitorRequest.Builder,StartQueryPerformanceMonitorRequest>
      Specified by:
      toBuilder in class NetworkFlowMonitorRequest
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends StartQueryPerformanceMonitorRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final 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
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.