Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AliasesApi

AliasesApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected basePath

basePath: string

Protected configuration

configuration: Configuration

Protected fetch

fetch: FetchAPI

Methods

createAlias

deleteAlias

  • Delete an alias.

    summary

    Delete Alias

    throws

    {RequiredError}

    memberof

    AliasesApi

    Parameters

    • workspace: string

      name of the workspace

    • alias: string

      name of the alias

    • Optional options: any

    Returns Promise<DeleteAliasResponse>

getAlias

  • getAlias(workspace: string, alias: string, options?: any): Promise<GetAliasResponse>
  • Get details about a alias

    summary

    Get Alias

    throws

    {RequiredError}

    memberof

    AliasesApi

    Parameters

    • workspace: string

      name of the workspace

    • alias: string

      name of the alias

    • Optional options: any

    Returns Promise<GetAliasResponse>

listAliases

  • Retrieve all aliases in an organization

    summary

    List Aliases

    throws

    {RequiredError}

    memberof

    AliasesApi

    Parameters

    • Optional options: any

    Returns Promise<ListAliasesResponse>

listQueryLambdasWithAlias

  • Get all Query Lambdas that hit a specific Rockset Alias.

    summary

    Get Query Lambdas with Alias

    throws

    {RequiredError}

    memberof

    AliasesApi

    Parameters

    • workspace: string
    • alias: string
    • Optional options: any

    Returns Promise<ListQueryLambdasResponse>

updateAlias

  • Update alias in a workspace.

    summary

    Update alias

    throws

    {RequiredError}

    memberof

    AliasesApi

    Parameters

    • workspace: string

      name of the workspace

    • alias: string

      name of the alias

    • body: UpdateAliasRequest

      JSON object

    • Optional options: any

    Returns Promise<GetAliasResponse>

workspaceAliases

  • Retrieve all aliases in a workspace.

    summary

    List Aliases for Workspace

    throws

    {RequiredError}

    memberof

    AliasesApi

    Parameters

    • workspace: string

      name of the workspace

    • Optional options: any

    Returns Promise<ListAliasesResponse>

Generated using TypeDoc