# PumpConfigurationAndControlTrait.OperationModeEnum

# PumpConfigurationAndControlTrait.OperationModeEnum


```
enum PumpConfigurationAndControlTrait.OperationModeEnum : Enum, ClusterEnum
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html) ||
|   | ↳ | [com.google.home.matter.standard.PumpConfigurationAndControlTrait.OperationModeEnum](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum) |

*** ** * ** ***

The various modes of operation for the pump.

## Summary

| ### Enum Values |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#Local` | The pump is running with the local settings of the pump, regardless of what those are. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#Maximum` | The pump is running at its maximum possible speed. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#Minimum` | The pump is running at its minimum possible speed. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#Normal` | The pump is controlled by a setpoint, as defined by a connected remote sensor or by the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.Attributes#controlMode()` attribute. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#UnknownValue` | The enum value is out of range. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#toDescription()()` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#valueOf(kotlin.String)(value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/kotlin/enums/EnumEntries<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#entries()` Returns a representation of an immutable list of all enum entries, in the order they're declared. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#traitId()` Trait identifier of the Matter Cluster that defines the enum Data Type. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#typeName()` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-long/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.OperationModeEnum#value()` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |

## Enum Values

### Local

```
val PumpConfigurationAndControlTrait.OperationModeEnum.Local: PumpConfigurationAndControlTrait.OperationModeEnum
```

The pump is running with the local settings of the pump, regardless of what those are.

### Maximum

```
val PumpConfigurationAndControlTrait.OperationModeEnum.Maximum: PumpConfigurationAndControlTrait.OperationModeEnum
```

The pump is running at its maximum possible speed.

### Minimum

```
val PumpConfigurationAndControlTrait.OperationModeEnum.Minimum: PumpConfigurationAndControlTrait.OperationModeEnum
```

The pump is running at its minimum possible speed.

### Normal

```
val PumpConfigurationAndControlTrait.OperationModeEnum.Normal: PumpConfigurationAndControlTrait.OperationModeEnum
```

The pump is controlled by a setpoint, as defined by a connected remote sensor or by the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/PumpConfigurationAndControlTrait.Attributes#controlMode()` attribute.

### UnknownValue

```
val PumpConfigurationAndControlTrait.OperationModeEnum.UnknownValue: PumpConfigurationAndControlTrait.OperationModeEnum
```

The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.

## Public functions

### toDescription

```
@HomeExperimentalGenericApi
fun toDescription(): String
```

### valueOf

```
fun valueOf(value: String): PumpConfigurationAndControlTrait.OperationModeEnum
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

```
fun values(): Array<PumpConfigurationAndControlTrait.OperationModeEnum>
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

## Public properties

### entries

```
val entries: EnumEntries<PumpConfigurationAndControlTrait.OperationModeEnum>
```

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

### traitId

```
open val traitId: String
```

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/ClusterId#traitId()` for the format.

### typeName

```
open val typeName: String
```

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

### value

```
open val value: ULong
```

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.