redshred.cli package

Module contents

class redshred.cli.Formats(value)

Bases: str, Enum

An enumeration.

json = 'json'

short = 'short'

template = 'template'

yaml = 'yaml'

class redshred.cli.GetTypes(value)

Bases: str, Enum

An enumeration.

collection = 'collection'

document = 'document'

page = 'page'

perspective = 'perspective'

segment = 'segment'

redshred.cli.create_collection(ctx: ~typer.models.Context, collection_name: str = <typer.models.ArgumentInfo object>, config: str = <typer.models.OptionInfo object>)

redshred.cli.get(ctx: ~typer.models.Context, collection: str = <typer.models.OptionInfo object>, get_type: ~redshred.cli.GetTypes = <typer.models.ArgumentInfo object>, obj: str = <typer.models.ArgumentInfo object>, field: ~typing.List[str] = <typer.models.OptionInfo object>, exclude_field: ~typing.List[str] = <typer.models.OptionInfo object>, exclude_large_fields: bool = <typer.models.OptionInfo object>)

redshred.cli.global_callback(ctx: ~typer.models.Context, context: str = <typer.models.OptionInfo object>, host: str = <typer.models.OptionInfo object>, host_verify: bool = <typer.models.OptionInfo object>, config_path: str = <typer.models.OptionInfo object>, token: str = <typer.models.OptionInfo object>, version: bool | None = <typer.models.OptionInfo object>, _format: ~redshred.cli.Formats = <typer.models.OptionInfo object>)

redshred.cli.init_client(context, host, host_verify, config_path, token)

redshred.cli.reread_document(ctx: ~typer.models.Context, collection: str = <typer.models.ArgumentInfo object>, document_id: str = <typer.models.ArgumentInfo object>, force: bool = <typer.models.OptionInfo object>)

redshred.cli.template(data)

redshred.cli.try_get(ctx: Context)

redshred.cli.try_get_collections(ctx)

redshred.cli.upload_document(ctx: ~typer.models.Context, collection_name: str = <typer.models.ArgumentInfo object>, document: str = <typer.models.ArgumentInfo object>)

redshred.cli.version_callback(value: bool)