software.amazon.awssdk.services.devicefarm.model

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(value="software.amazon.awssdk:codegen")
public final class UpdateDevicePoolRequest
extends DeviceFarmRequest
implements ToCopyableBuilder<UpdateDevicePoolRequest.Builder,UpdateDevicePoolRequest>

Represents a request to the update device pool operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateDevicePoolRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
static UpdateDevicePoolRequest.Builder	builder()
Boolean	clearMaxDevices() Sets whether the maxDevices parameter applies to your device pool.
String	description() A description of the device pool you wish to update.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxDevices() The number of devices that Device Farm can add to your device pool.
String	name() A string representing the name of the device pool you wish to update.
List<Rule>	rules() Represents the rules you wish to modify for the device pool.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDevicePoolRequest.Builder>	serializableBuilderClass()
UpdateDevicePoolRequest.Builder	toBuilder()
String	toString() 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

arn

public String arn()

The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.

Returns:

The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.

name

public String name()

A string representing the name of the device pool you wish to update.

Returns:

A string representing the name of the device pool you wish to update.

description

public String description()

A description of the device pool you wish to update.

Returns:

A description of the device pool you wish to update.

rules

public List<Rule> rules()

Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.

maxDevices

public 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 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 that are specified for 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 that are specified for 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()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDevicePoolRequest.Builder,UpdateDevicePoolRequest>

Specified by:

toBuilder in class DeviceFarmRequest

builder

public static UpdateDevicePoolRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo