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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStartSessionsStatisticsAggregationRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StartSessionsStatisticsAggregationRequest.Builderbuilder()InstantendTime()The Linux timestamp of the date and time that the statistics end.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfarmId()The identifier of the farm that contains queues or fleets to return statistics for.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)List<UsageGroupByField>groupBy()The field to use to group the statistics.List<String>groupByAsStrings()The field to use to group the statistics.booleanhasGroupBy()For responses, this returns true if the service returned a value for the GroupBy property.inthashCode()booleanhasStatistics()For responses, this returns true if the service returned a value for the Statistics property.Periodperiod()The period to aggregate the statistics.StringperiodAsString()The period to aggregate the statistics.SessionsStatisticsResourcesresourceIds()A list of fleet IDs or queue IDs to gather statistics for.List<SdkField<?>>sdkFields()static Class<? extends StartSessionsStatisticsAggregationRequest.Builder>serializableBuilderClass()InstantstartTime()The Linux timestamp of the date and time that the statistics start.List<UsageStatistic>statistics()One to four statistics to return.List<String>statisticsAsStrings()One to four statistics to return.Stringtimezone()The timezone to use for the statistics.StartSessionsStatisticsAggregationRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
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 theisEmpty()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,
periodwill returnPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromperiodAsString().- 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,
periodwill returnPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromperiodAsString().- 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 theisEmpty()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."
-
toBuilder
public StartSessionsStatisticsAggregationRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StartSessionsStatisticsAggregationRequest.Builder,StartSessionsStatisticsAggregationRequest>- Specified by:
toBuilderin classDeadlineRequest
-
builder
public static StartSessionsStatisticsAggregationRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartSessionsStatisticsAggregationRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-