# PlannedExerciseStep

Artifact: [androidx.health.connect:connect-client](https://developer.android.com/jetpack/androidx/releases/health-connect) [View Source](https://cs.android.com/search?q=file:androidx/health/connect/client/records/PlannedExerciseStep.kt+class:androidx.health.connect.client.records.PlannedExerciseStep) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
public final class PlannedExerciseStep
```

<br />

*** ** * ** ***

A single step within an `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseBlock` e.g. 8x 60kg barbell squats.

## Summary

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_ACTIVE() = 3` Active exercise. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_COOLDOWN() = 4` Cooldown exercise, typically at the end of a workout. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_RECOVERY() = 5` Lower intensity, active exercise. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_REST() = 2` A rest. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_UNKNOWN() = 0` An unknown phase of exercise. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_WARMUP() = 1` A warmup. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#PlannedExerciseStep(kotlin.Int,kotlin.Int,androidx.health.connect.client.records.ExerciseCompletionGoal,kotlin.collections.List,kotlin.String)( int exerciseType, int exercisePhase, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/records/ExerciseCompletionGoal completionGoal, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/records/ExercisePerformanceTarget> performanceTargets, https://developer.android.com/reference/java/lang/String.html description )` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/records/ExerciseCompletionGoal` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#getCompletionGoal()()` The goal that must be completed to finish this step. |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#getDescription()()` The description of this step. |
| `final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#getExercisePhase()()` The phase e.g. 'warmup' that this step belongs to. |
| `final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#getExerciseType()()` The type of exercise that this step involves. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/records/ExercisePerformanceTarget>` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#getPerformanceTargets()()` Performance related targets that should be met during this step. |
| `int` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/PlannedExerciseStep#toString()()` |

## Constants

### EXERCISE_PHASE_ACTIVE

```
public static final int EXERCISE_PHASE_ACTIVE = 3
```

Active exercise.

### EXERCISE_PHASE_COOLDOWN

```
public static final int EXERCISE_PHASE_COOLDOWN = 4
```

Cooldown exercise, typically at the end of a workout.

### EXERCISE_PHASE_RECOVERY

```
public static final int EXERCISE_PHASE_RECOVERY = 5
```

Lower intensity, active exercise.

### EXERCISE_PHASE_REST

```
public static final int EXERCISE_PHASE_REST = 2
```

A rest.

### EXERCISE_PHASE_UNKNOWN

```
public static final int EXERCISE_PHASE_UNKNOWN = 0
```

An unknown phase of exercise.

### EXERCISE_PHASE_WARMUP

```
public static final int EXERCISE_PHASE_WARMUP = 1
```

A warmup.

## Public constructors

### PlannedExerciseStep

```
public PlannedExerciseStep(
    int exerciseType,
    int exercisePhase,
    @NonNull ExerciseCompletionGoal completionGoal,
    @NonNull List<@NonNull ExercisePerformanceTarget> performanceTargets,
    String description
)
```

| Parameters |
|---|---|
| `int exerciseType` | The type of exercise that this step involves. |
| `int exercisePhase` | The phase e.g. 'warmup' that this step belongs to. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/records/ExerciseCompletionGoal completionGoal` | The goal that must be completed to finish this step. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/records/ExercisePerformanceTarget> performanceTargets` | Performance related targets that should be met during this step. |
| `https://developer.android.com/reference/java/lang/String.html description` | The description of this step. |

## Public methods

### equals

```
public boolean equals(Object other)
```

### getCompletionGoal

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public final @NonNull ExerciseCompletionGoal getCompletionGoal()
```

The goal that must be completed to finish this step.

### getDescription

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public final String getDescription()
```

The description of this step.

### getExercisePhase

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public final int getExercisePhase()
```

The phase e.g. 'warmup' that this step belongs to.

### getExerciseType

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public final int getExerciseType()
```

The type of exercise that this step involves.

### getPerformanceTargets

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public final @NonNull List<@NonNull ExercisePerformanceTarget> getPerformanceTargets()
```

Performance related targets that should be met during this step.

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```