Class GetTimeSeriesServiceStatisticsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.xray.model.XRayRequest
software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTimeSeriesServiceStatisticsRequest.Builder,GetTimeSeriesServiceStatisticsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetTimeSeriesServiceStatisticsRequest extends XRayRequest implements ToCopyableBuilder<GetTimeSeriesServiceStatisticsRequest.Builder,GetTimeSeriesServiceStatisticsRequest>

  • Method Details

    • startTime

      public final Instant startTime()

      The start of the time frame for which to aggregate statistics.

      Returns:
      The start of the time frame for which to aggregate statistics.

    • endTime

      public final Instant endTime()

      The end of the time frame for which to aggregate statistics.

      Returns:
      The end of the time frame for which to aggregate statistics.

    • groupName

      public final String groupName()

      The case-sensitive name of the group for which to pull statistics from.

      Returns:
      The case-sensitive name of the group for which to pull statistics from.

    • groupARN

      public final String groupARN()

      The Amazon Resource Name (ARN) of the group for which to pull statistics from.

      Returns:
      The Amazon Resource Name (ARN) of the group for which to pull statistics from.

    • entitySelectorExpression

      public final String entitySelectorExpression()

      A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

      Returns:
      A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

    • period

      public final Integer period()

      Aggregation period in seconds.

      Returns:
      Aggregation period in seconds.

    • forecastStatistics

      public final Boolean forecastStatistics()

      The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

      Returns:
      The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

    • nextToken

      public final String nextToken()

      Pagination token.

      Returns:
      Pagination token.

    • toBuilder

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

    • builder

      public static GetTimeSeriesServiceStatisticsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetTimeSeriesServiceStatisticsRequest.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.