Package software.amazon.awssdk.services.codeguruprofiler.model

Class BatchGetFrameMetricDataResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.codeguruprofiler.model.CodeGuruProfilerResponse
software.amazon.awssdk.services.codeguruprofiler.model.BatchGetFrameMetricDataResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<BatchGetFrameMetricDataResponse.Builder,BatchGetFrameMetricDataResponse>
@Generated("software.amazon.awssdk:codegen") public final class BatchGetFrameMetricDataResponse extends CodeGuruProfilerResponse implements ToCopyableBuilder<BatchGetFrameMetricDataResponse.Builder,BatchGetFrameMetricDataResponse>

The structure representing the BatchGetFrameMetricDataResponse.

  • Method Details

    • endTime

      public final Instant endTime()

      The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

      Returns:
      The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

    • hasEndTimes

      public final boolean hasEndTimes()
      For responses, this returns true if the service returned a value for the EndTimes 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.

    • endTimes

      public final List<TimestampStructure> endTimes()

      List of instances, or time steps, in the time series. For example, if the period is one day ( PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

      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 hasEndTimes() method.

      Returns:
      List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

    • hasFrameMetricData

      public final boolean hasFrameMetricData()
      For responses, this returns true if the service returned a value for the FrameMetricData 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.

    • frameMetricData

      public final List<FrameMetricDatum> frameMetricData()

      Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

      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 hasFrameMetricData() method.

      Returns:
      Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

    • resolution

      public final AggregationPeriod resolution()

      Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

      • P1D — 1 day

      • PT1H — 1 hour

      • PT5M — 5 minutes

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

      Returns:
      Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

      • P1D — 1 day

      • PT1H — 1 hour

      • PT5M — 5 minutes

      See Also:

    • resolutionAsString

      public final String resolutionAsString()

      Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

      • P1D — 1 day

      • PT1H — 1 hour

      • PT5M — 5 minutes

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

      Returns:
      Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

      • P1D — 1 day

      • PT1H — 1 hour

      • PT5M — 5 minutes

      See Also:

    • startTime

      public final Instant startTime()

      The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

      Returns:
      The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

    • hasUnprocessedEndTimes

      public final boolean hasUnprocessedEndTimes()
      For responses, this returns true if the service returned a value for the UnprocessedEndTimes 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.

    • unprocessedEndTimes

      public final Map<String,List<TimestampStructure>> unprocessedEndTimes()

      List of instances which remained unprocessed. This will create a missing time step in the list of end times.

      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 hasUnprocessedEndTimes() method.

      Returns:
      List of instances which remained unprocessed. This will create a missing time step in the list of end times.

    • toBuilder

      public BatchGetFrameMetricDataResponse.Builder 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<BatchGetFrameMetricDataResponse.Builder,BatchGetFrameMetricDataResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static BatchGetFrameMetricDataResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BatchGetFrameMetricDataResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.