Class UpdateDevicePoolRequest

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

Represents a request to the update device pool operation.

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the Device Farm device pool to update.

      Returns:
      The Amazon Resource Name (ARN) of the Device Farm device pool to update.

    • name

      public final String name()

      A string that represents the name of the device pool to update.

      Returns:
      A string that represents the name of the device pool to update.

    • description

      public final String description()

      A description of the device pool to update.

      Returns:
      A description of the device pool to update.

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

      Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing 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:
      Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing 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 that 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.

      If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.

      Returns:
      The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that 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.

      If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.

    • clearMaxDevices

      public final Boolean clearMaxDevices()

      Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the rules parameter.

      If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.

      Returns:
      Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the rules parameter.

      If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.

    • toBuilder

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

    • builder

      public static UpdateDevicePoolRequest.Builder builder()

    • serializableBuilderClass

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