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

# CatalogRead

> What a catalog read found.

```csharp
public sealed record CatalogRead : IEquatable<CatalogRead>
```

**Implements:** `IEquatable<CatalogRead>`

## Constructors

```csharp
public CatalogRead(IReadOnlyDictionary<string, IReadOnlyList<CatalogValue>> Values, IReadOnlyList<CatalogReadError> ReadErrors)
```

What a catalog read found.

### Parameters

**Values** `IReadOnlyDictionary\<String,IReadOnlyList\<CatalogValue\>\>` *required*

**Type:** `IReadOnlyDictionary<String,IReadOnlyList<CatalogValue>>`

The values each `values_from` lookup list holds.

**ReadErrors** `IReadOnlyList\<CatalogReadError\>` *required*

**Type:** `IReadOnlyList<CatalogReadError>`

The parts that could not be read.

## Properties

**ReadErrors** `IReadOnlyList\<CatalogReadError\>` *required*

**Type:** `IReadOnlyList<CatalogReadError>`

The parts that could not be read.

**Records** `IReadOnlyDictionary\<String,IReadOnlyList\<CatalogValue\>\>` *required*

**Type:** `IReadOnlyDictionary<String,IReadOnlyList<CatalogValue>>`

The records of each object fields take values from, by the object's key.

**Resources** `IReadOnlyDictionary\<String,IReadOnlyList\<Resource\>\>` *required*

**Type:** `IReadOnlyDictionary<String,IReadOnlyList<Resource>>`

Every declared resource, by kind.

**TenantFields** `IReadOnlyList\<TenantFields\>` *required*

**Type:** `IReadOnlyList<TenantFields>`

The fields the tenant adds at each extensible item.

**Values** `IReadOnlyDictionary\<String,IReadOnlyList\<CatalogValue\>\>` *required*

**Type:** `IReadOnlyDictionary<String,IReadOnlyList<CatalogValue>>`

The values each `values_from` lookup list holds.

## Methods

### Deconstruct()

```csharp
public void Deconstruct(out IReadOnlyDictionary<string, IReadOnlyList<CatalogValue>> Values, out IReadOnlyList<CatalogReadError> ReadErrors)
```

#### Parameters

**Values** `IReadOnlyDictionary\<String,IReadOnlyList\<CatalogValue\>\>` *required*

**Type:** `IReadOnlyDictionary<String,IReadOnlyList<CatalogValue>>`

**ReadErrors** `IReadOnlyList\<CatalogReadError\>` *required*

**Type:** `IReadOnlyList<CatalogReadError>`

### Equals()

```csharp
public bool Equals(CatalogRead? other)
```

#### Parameters

**other** `CatalogRead` *required*

#### Returns

`bool`

```csharp
public override bool Equals(object? obj)
```

#### Parameters

**obj** `object` *required*

#### Returns

`bool`

### GetHashCode()

```csharp
public override int GetHashCode()
```

#### Returns

`int`

### operator !=()

```csharp
public static bool operator !=(CatalogRead? left, CatalogRead? right)
```

#### Parameters

**left** `CatalogRead` *required*

**right** `CatalogRead` *required*

#### Returns

`bool`

### operator ==()

```csharp
public static bool operator ==(CatalogRead? left, CatalogRead? right)
```

#### Parameters

**left** `CatalogRead` *required*

**right** `CatalogRead` *required*

#### Returns

`bool`

### ToString()

```csharp
public override string ToString()
```

#### Returns

`string`

### ValuesOf()

```csharp
public IReadOnlyList<CatalogValue>? ValuesOf(ValueSource source)
```

Gets the values a source holds, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when it was not read.

#### Parameters

**source** `ValueSource` *required*

#### Returns

`IReadOnlyList<CatalogValue>`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.