Class SessionsStatisticsResources
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SessionsStatisticsResources.Builder,
SessionsStatisticsResources>
Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet IDs or queue IDS, not both.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.fleetIds()
One to 10 fleet IDs that specify the fleets to return statistics for.static SessionsStatisticsResources
fromFleetIds
(List<String> fleetIds) Create an instance of this class withfleetIds()
initialized to the given value.static SessionsStatisticsResources
fromQueueIds
(List<String> queueIds) Create an instance of this class withqueueIds()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FleetIds property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the QueueIds property.queueIds()
One to 10 queue IDs that specify the queues to return statistics for.static Class
<? extends SessionsStatisticsResources.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasFleetIds
public final boolean hasFleetIds()For responses, this returns true if the service returned a value for the FleetIds 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. -
fleetIds
One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the
fleetIds
field, you can't specify thequeueIds
field.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
hasFleetIds()
method.- Returns:
- One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the
fleetIds
field, you can't specify thequeueIds
field.
-
hasQueueIds
public final boolean hasQueueIds()For responses, this returns true if the service returned a value for the QueueIds 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. -
queueIds
One to 10 queue IDs that specify the queues to return statistics for. If you specify the
queueIds
field, you can't specify thefleetIds
field.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
hasQueueIds()
method.- Returns:
- One to 10 queue IDs that specify the queues to return statistics for. If you specify the
queueIds
field, you can't specify thefleetIds
field.
-
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 interfaceToCopyableBuilder<SessionsStatisticsResources.Builder,
SessionsStatisticsResources> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
fromFleetIds
Create an instance of this class withfleetIds()
initialized to the given value.One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the
fleetIds
field, you can't specify thequeueIds
field.- Parameters:
fleetIds
- One to 10 fleet IDs that specify the fleets to return statistics for. If you specify thefleetIds
field, you can't specify thequeueIds
field.
-
fromQueueIds
Create an instance of this class withqueueIds()
initialized to the given value.One to 10 queue IDs that specify the queues to return statistics for. If you specify the
queueIds
field, you can't specify thefleetIds
field.- Parameters:
queueIds
- One to 10 queue IDs that specify the queues to return statistics for. If you specify thequeueIds
field, you can't specify thefleetIds
field.
-
type
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beSessionsStatisticsResources.Type.UNKNOWN_TO_SDK_VERSION
if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beSessionsStatisticsResources.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-