> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IWorkspaceCatalogFactoryMethods

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/ldm/catalog.ts

Common methods for catalog configuration

**Signature:**

```typescript
export interface IWorkspaceCatalogFactoryMethods<TFactory, TOptions> 
```

## Methods

| Method | Description |
| --- | --- |
| [excludeTags(tags)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactorymethods/index.md#iworkspacecatalogfactorymethodsexcludetags) | Setup catalog to fetch only items without provided tags |
| [forDataset(dataset)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactorymethods/index.md#iworkspacecatalogfactorymethodsfordataset) | Setup catalog to fetch only items of the provided dataset |
| [forTypes(types)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactorymethods/index.md#iworkspacecatalogfactorymethodsfortypes) | Setup catalog to fetch only items of the provided types (attribute, measure, fact or dateDataset) |
| [includeTags(tags)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactorymethods/index.md#iworkspacecatalogfactorymethodsincludetags) | Setup catalog to fetch only items with provided tags |
| [withGroups(loadGroups)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactorymethods/index.md#iworkspacecatalogfactorymethodswithgroups) | Setup whether catalog should fetch groups. Default: true |
| [withOptions(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactorymethods/index.md#iworkspacecatalogfactorymethodswithoptions) | Setup catalog to fetch only items for specific options |
| [withPageSize(pageSize)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactorymethods/index.md#iworkspacecatalogfactorymethodswithpagesize) | Setup whether catalog should fetch production ready items. Default: 250 |
| [withSignal(signal)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactorymethods/index.md#iworkspacecatalogfactorymethodswithsignal) | Setup to use abort signal |

## Method details

### IWorkspaceCatalogFactoryMethods.excludeTags()

Setup catalog to fetch only items without provided tags

**Signature:**

```typescript
excludeTags(tags: ObjRef[]): TFactory;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| tags | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | tags references |

**Returns:**

TFactory

catalog factory

### IWorkspaceCatalogFactoryMethods.forDataset()

Setup catalog to fetch only items of the provided dataset

**Signature:**

```typescript
forDataset(dataset: ObjRef): TFactory;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dataset | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | dataset reference |

**Returns:**

TFactory

catalog factory

### IWorkspaceCatalogFactoryMethods.forTypes()

Setup catalog to fetch only items of the provided types (attribute, measure, fact or dateDataset)

**Signature:**

```typescript
forTypes(types: CatalogItemType[]): TFactory;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| types | [CatalogItemType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.catalogitemtype/index.md)[] | catalog item types |

**Returns:**

TFactory

catalog factory

### IWorkspaceCatalogFactoryMethods.includeTags()

Setup catalog to fetch only items with provided tags

**Signature:**

```typescript
includeTags(tags: ObjRef[]): TFactory;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| tags | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | tags references |

**Returns:**

TFactory

catalog factory

### IWorkspaceCatalogFactoryMethods.withGroups()

Setup whether catalog should fetch groups. Default: true

**Signature:**

```typescript
withGroups(loadGroups: boolean): TFactory;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| loadGroups | boolean | should fetch groups |

**Returns:**

TFactory

catalog factory

### IWorkspaceCatalogFactoryMethods.withOptions()

Setup catalog to fetch only items for specific options

**Signature:**

```typescript
withOptions(options: Partial<TOptions>): TFactory;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | Partial&lt;TOptions&gt; | catalog options |

**Returns:**

TFactory

catalog factory

### IWorkspaceCatalogFactoryMethods.withPageSize()

Setup whether catalog should fetch production ready items. Default: 250

**Signature:**

```typescript
withPageSize(pageSize: number): TFactory;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | number | page size of items |

**Returns:**

TFactory

### IWorkspaceCatalogFactoryMethods.withSignal()

Setup to use abort signal

**Signature:**

```typescript
withSignal(signal: AbortSignal): TFactory;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| signal | AbortSignal | abort signal |

**Returns:**

TFactory

catalog factory