Class StartSessionsStatisticsAggregationRequest

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

  • Method Details

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

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

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

    • 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."

    • 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:

    • 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:

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

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

    • toBuilder

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

    • builder

      public static StartSessionsStatisticsAggregationRequest.Builder builder()

    • serializableBuilderClass

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