> ## Documentation Index
> Fetch the complete documentation index at: https://docs.validio.io/llms.txt
> Use this file to discover all available pages before exploring further.

# validio_sdk.code.plan module

> Plan command implementation.

Plan command implementation.

### PlanResult

```python
class validio_sdk.code.plan.PlanResult(graph_diff: GraphDiff, diff_context: DiffContext, tags_context: DiffContext, deprecations: list[ResourceDeprecation], feature_notices: list[ResourceFeatureNotice])
```

**Parameters**

**graph\_diff** `GraphDiff` *required*

**diff\_context** `DiffContext` *required*

**tags\_context** `DiffContext` *required*

**deprecations** `list[ResourceDeprecation]` *required*

**feature\_notices** `list[ResourceFeatureNotice]` *required*

Bases: `object`

Result from a plan operation.

#### deprecations

```python
deprecations: list[ResourceDeprecation]
```

#### diff\_context

```python
diff_context: DiffContext
```

#### feature\_notices

```python
feature_notices: list[ResourceFeatureNotice]
```

#### graph\_diff

```python
graph_diff: GraphDiff
```

#### tags\_context

```python
tags_context: DiffContext
```

### ResourceNames

```python
class validio_sdk.code.plan.ResourceNames(tags: set[str] = <factory>, credentials: set[str] = <factory>, channels: set[str] = <factory>, sources: set[str] = <factory>, windows: set[str] = <factory>, filters: set[str] = <factory>, segmentations: set[str] = <factory>, validators: set[str] = <factory>, validator_debug_queries: set[str] = <factory>, notification_rules: set[str] = <factory>)
```

**Parameters**

**tags** `set[str]`

**credentials** `set[str]`

**channels** `set[str]`

**sources** `set[str]`

**windows** `set[str]`

**filters** `set[str]`

**segmentations** `set[str]`

**validators** `set[str]`

**validator\_debug\_queries** `set[str]`

**notification\_rules** `set[str]`

Bases: `object`

Holds names for resource types, can be used for retaining.

#### channels

```python
channels: set[str]
```

#### credentials

```python
credentials: set[str]
```

#### filters

```python
filters: set[str]
```

#### notification\_rules

```python
notification_rules: set[str]
```

#### segmentations

```python
segmentations: set[str]
```

#### size()

```python
size() → int
```

**Returns:** `int`

Get the size of resources.

Return the total number of items in all sets.

#### sources

```python
sources: set[str]
```

#### tags

```python
tags: set[str]
```

#### validator\_debug\_queries

```python
validator_debug_queries: set[str]
```

#### validators

```python
validators: set[str]
```

#### windows

```python
windows: set[str]
```

### plan()

```python
async validio_sdk.code.plan.plan(namespace: str, client: APIClient, directory: Path, schema_reinference: SourceSchemaReinference, destroy: bool, no_capture: bool, show_secrets: bool, targets: ResourceNames = ResourceNames(tags=set(), credentials=set(), channels=set(), sources=set(), windows=set(), filters=set(), segmentations=set(), validators=set(), validator_debug_queries=set(), notification_rules=set()), show_progress: bool = True, schema_inference_skip: SourceSchemaInferenceSkip = SourceSchemaInferenceSkip(source_names=None)) → PlanResult
```

**Parameters**

**namespace** `str` *required*

**client** `APIClient` *required*

**directory** `Path` *required*

**schema\_reinference** `SourceSchemaReinference` *required*

**destroy** `bool` *required*

**no\_capture** `bool` *required*

**show\_secrets** `bool` *required*

**targets** `ResourceNames`

**show\_progress** `bool`

**schema\_inference\_skip** `SourceSchemaInferenceSkip`

**Returns:** `PlanResult`

Computes a diff between the manifest program and the live server resources.
