Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryLambdasApi

QueryLambdasApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected basePath

basePath: string

Protected configuration

configuration: Configuration

Protected fetch

fetch: FetchAPI

Methods

createQueryLambda

createQueryLambdaTag

  • Create a tag for a specific Query Lambda version, or update that tag if it already exists.

    summary

    Create Query Lambda Tag

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • body: CreateQueryLambdaTagRequest

      JSON object

    • Optional options: any

    Returns Promise<QueryLambdaTagResponse>

deleteQueryLambda

  • Delete a Query Lambda.

    summary

    Delete Query Lambda

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • Optional options: any

    Returns Promise<DeleteQueryLambdaResponse>

deleteQueryLambdaTag

  • deleteQueryLambdaTag(workspace: string, queryLambda: string, tag: string, options?: any): Promise<QueryLambdaTagResponse>
  • Delete a tag for a specific Query Lambda

    summary

    Delete Query Lambda Tag Version

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • tag: string

      name of the tag

    • Optional options: any

    Returns Promise<QueryLambdaTagResponse>

deleteQueryLambdaVersion

  • deleteQueryLambdaVersion(workspace: string, queryLambda: string, version: string, options?: any): Promise<QueryLambdaVersionResponse>
  • Delete a Query Lambda version.

    summary

    Delete Query Lambda Version

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • version: string

      version

    • Optional options: any

    Returns Promise<QueryLambdaVersionResponse>

executeQueryLambda

  • Execute a particular version of a Query Lambda.

    summary

    Execute Query Lambda

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • version: string

      version

    • Optional body: ExecuteQueryLambdaRequest
    • Optional options: any

    Returns Promise<QueryResponse>

executeQueryLambdaByTag

  • Execute the Query Lambda version associated with a given tag.

    summary

    Execute Query Lambda By Tag

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • tag: string

      tag

    • Optional body: ExecuteQueryLambdaRequest
    • Optional options: any

    Returns Promise<QueryResponse>

getAggregateQueryLambdaStats

  • getAggregateQueryLambdaStats(workspace: string, queryLambda: string, version: string, start: number, end: number, interval?: undefined | number, options?: any): Promise<AggregateQueryLambdaStatsResponse>
  • Get aggregate Query Lambda usage data for a time window, at requested intervals.

    summary

    Get Query Lambda Stats

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • version: string

      version

    • start: number

      start time (ms)

    • end: number

      end time (ms)

    • Optional interval: undefined | number
    • Optional options: any

    Returns Promise<AggregateQueryLambdaStatsResponse>

getQueryLambdaTagVersion

  • getQueryLambdaTagVersion(workspace: string, queryLambda: string, tag: string, options?: any): Promise<QueryLambdaTagResponse>
  • Get the Query Lambda version associated with a given tag.

    summary

    Get Query Lambda Tag

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • tag: string

      name of the tag

    • Optional options: any

    Returns Promise<QueryLambdaTagResponse>

getQueryLambdaVersion

  • getQueryLambdaVersion(workspace: string, queryLambda: string, version: string, options?: any): Promise<QueryLambdaVersionResponse>
  • Get details for a specified version of a Query Lambda.

    summary

    Get Query Lambda Version

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • version: string

      version

    • Optional options: any

    Returns Promise<QueryLambdaVersionResponse>

listAllQueryLambdas

listOrganizationTags

listQueryLambdaTagVersions

  • List all Query Lambda versions associated with a given tag.

    summary

    List Query Lambda Tag Versions

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • tag: string

      name of the tag

    • Optional options: any

    Returns Promise<ListQueryLambdaVersionsResponse>

listQueryLambdaTags

  • List all tags associated with a Query Lambda

    summary

    List Query Lambda Tags

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • Optional options: any

    Returns Promise<ListQueryLambdaTagsResponse>

listQueryLambdaVersions

  • List all versions of a Query Lambda.

    summary

    List Query Lambda Versions

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • Optional options: any

    Returns Promise<ListQueryLambdaVersionsResponse>

listQueryLambdasInWorkspace

  • List all Query Lambdas under given workspace.

    summary

    List Query Lambdas in Workspace

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • Optional options: any

    Returns Promise<ListQueryLambdasResponse>

updateQueryLambda

  • Create a new version of a Query Lambda in given workspace.

    summary

    Update Query Lambda

    throws

    {RequiredError}

    memberof

    QueryLambdasApi

    Parameters

    • workspace: string

      name of the workspace

    • queryLambda: string

      name of the Query Lambda

    • body: UpdateQueryLambdaRequest

      JSON object

    • Optional create: undefined | false | true
    • Optional options: any

    Returns Promise<QueryLambdaVersionResponse>

Generated using TypeDoc