Class StartSessionsStatisticsAggregationRequest

    • Method Detail

      • endTime

        public final Instant endTime()

        The Linux timestamp of the date and time that the statistics end.

        Returns:
        The Linux timestamp of the date and time that the statistics end.
      • farmId

        public final String farmId()

        The identifier of the farm that contains queues or fleets to return statistics for.

        Returns:
        The identifier of the farm that contains queues or fleets to return statistics for.
      • groupBy

        public final List<UsageGroupByField> groupBy()

        The field to use to group the statistics.

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

        Returns:
        The field to use to group the statistics.
      • hasGroupBy

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

        public final List<String> groupByAsStrings()

        The field to use to group the statistics.

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

        Returns:
        The field to use to group the statistics.
      • period

        public final Period period()

        The period to aggregate the statistics.

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

        Returns:
        The period to aggregate the statistics.
        See Also:
        Period
      • periodAsString

        public final String periodAsString()

        The period to aggregate the statistics.

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

        Returns:
        The period to aggregate the statistics.
        See Also:
        Period
      • resourceIds

        public final SessionsStatisticsResources resourceIds()

        A list of fleet IDs or queue IDs to gather statistics for.

        Returns:
        A list of fleet IDs or queue IDs to gather statistics for.
      • startTime

        public final Instant startTime()

        The Linux timestamp of the date and time that the statistics start.

        Returns:
        The Linux timestamp of the date and time that the statistics start.
      • statistics

        public final List<UsageStatistic> statistics()

        One to four statistics to return.

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

        Returns:
        One to four statistics to return.
      • hasStatistics

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

        public final List<String> statisticsAsStrings()

        One to four statistics to return.

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

        Returns:
        One to four statistics to return.
      • timezone

        public final String timezone()

        The timezone to use for the statistics. Use UTC notation such as "UTC+8."

        Returns:
        The timezone to use for the statistics. Use UTC notation such as "UTC+8."
      • 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