Class DevicePool

java.lang.Object
software.amazon.awssdk.services.devicefarm.model.DevicePool
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DevicePool.Builder,DevicePool>
@Generated("software.amazon.awssdk:codegen") public final class DevicePool extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DevicePool.Builder,DevicePool>

Represents a collection of device types.

See Also:

  • Method Details

    • arn

      public final String arn()

      The device pool's ARN.

      Returns:
      The device pool's ARN.

    • name

      public final String name()

      The device pool's name.

      Returns:
      The device pool's name.

    • description

      public final String description()

      The device pool's description.

      Returns:
      The device pool's description.

    • type

      public final DevicePoolType type()

      The device pool's type.

      Allowed values include:

      • CURATED: A device pool that is created and managed by AWS Device Farm.

      • PRIVATE: A device pool that is created and managed by the device pool developer.

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

      Returns:
      The device pool's type.

      Allowed values include:

      • CURATED: A device pool that is created and managed by AWS Device Farm.

      • PRIVATE: A device pool that is created and managed by the device pool developer.

      See Also:

    • typeAsString

      public final String typeAsString()

      The device pool's type.

      Allowed values include:

      • CURATED: A device pool that is created and managed by AWS Device Farm.

      • PRIVATE: A device pool that is created and managed by the device pool developer.

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

      Returns:
      The device pool's type.

      Allowed values include:

      • CURATED: A device pool that is created and managed by AWS Device Farm.

      • PRIVATE: A device pool that is created and managed by the device pool developer.

      See Also:

    • hasRules

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

    • rules

      public final List<Rule> rules()

      Information about the device pool's rules.

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

      Returns:
      Information about the device pool's rules.

    • maxDevices

      public final Integer maxDevices()

      The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

      By specifying the maximum number of devices, you can control the costs that you incur by running tests.

      Returns:
      The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

      By specifying the maximum number of devices, you can control the costs that you incur by running tests.

    • toBuilder

      public DevicePool.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<DevicePool.Builder,DevicePool>
      Returns:
      a builder for type T

    • builder

      public static DevicePool.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DevicePool.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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