# union.configuration

## Directory

### Classes

| Class | Description |
|-|-|
| [`UnionAIPlugin`](https://www.union.ai/docs/v1/union/api-reference/union-sdk/packages/union.configuration/page.md#unionconfigurationunionaiplugin) |  |

## union.configuration.UnionAIPlugin

### Methods

| Method | Description |
|-|-|
| [`configure_pyflyte_cli()`](#configure_pyflyte_cli) | Configure pyflyte's CLI. |
| [`get_auth_success_html()`](#get_auth_success_html) | Get default success html. |
| [`get_default_cache_policies()`](#get_default_cache_policies) | Get default cache policies for tasks. |
| [`get_default_image()`](#get_default_image) | Return default image. |
| [`get_remote()`](#get_remote) |  |
| [`secret_requires_group()`](#secret_requires_group) | Return True if secrets require group entry. |

#### configure_pyflyte_cli()

```python
def configure_pyflyte_cli(
    main: click.core.Group,
) -> click.core.Group
```
Configure pyflyte's CLI.

| Parameter | Type | Description |
|-|-|-|
| `main` | `click.core.Group` | |

#### get_auth_success_html()

```python
def get_auth_success_html(
    endpoint: str,
) -> typing.Optional[str]
```
Get default success html. Return None to use flytekit's default success html.

| Parameter | Type | Description |
|-|-|-|
| `endpoint` | `str` | |

#### get_default_cache_policies()

```python
def get_default_cache_policies()
```
Get default cache policies for tasks.

#### get_default_image()

```python
def get_default_image()
```
Return default image.

#### get_remote()

```python
def get_remote(
    config: typing.Optional[str],
    project: str,
    domain: str,
    data_upload_location: typing.Optional[str],
) -> UnionRemote
```
| Parameter | Type | Description |
|-|-|-|
| `config` | `typing.Optional[str]` | |
| `project` | `str` | |
| `domain` | `str` | |
| `data_upload_location` | `typing.Optional[str]` | |

#### secret_requires_group()

```python
def secret_requires_group()
```
Return True if secrets require group entry.

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/union-sdk/packages/union.configuration.md
**HTML**: https://www.union.ai/docs/v1/union/api-reference/union-sdk/packages/union.configuration/