Class API

constructor

• new API(client): Function.v1beta1.API

• Parameters

  • client: Client

  Returns Function.v1beta1.API

Static ReadonlyLOCALITIES

createCron

• createCron(request): Promise<Function.v1beta1.Cron>

• Create a new cron. Create a new cronjob for a function with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.CreateCronRequest>

    The request CreateCronRequest

  Returns Promise<Function.v1beta1.Cron>

  A Promise of Cron

createDomain

• createDomain(request): Promise<Function.v1beta1.Domain>

• Create a domain name binding. Create a domain name binding for the function with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.CreateDomainRequest>

    The request CreateDomainRequest

  Returns Promise<Function.v1beta1.Domain>

  A Promise of Domain

createFunction

• createFunction(request): Promise<Function>

• Create a new function. Create a new function in the specified region for a specified Organization or Project.

  Parameters

  • request: Readonly<CreateFunctionRequest>

    The request CreateFunctionRequest

  Returns Promise<Function>

  A Promise of Function

createNamespace

• createNamespace(request?): Promise<Function.v1beta1.Namespace>

• Create a new namespace. Create a new namespace in a specified Organization or Project.

  Parameters

  • request: Readonly<Function.v1beta1.CreateNamespaceRequest> = {}

    The request CreateNamespaceRequest

  Returns Promise<Function.v1beta1.Namespace>

  A Promise of Namespace

createToken

• createToken(request?): Promise<Function.v1beta1.Token>

• Create a new revocable token.

  Parameters

  • request: Readonly<Function.v1beta1.CreateTokenRequest> = {}

    The request CreateTokenRequest

  Returns Promise<Function.v1beta1.Token>

  A Promise of Token

createTrigger

• createTrigger(request): Promise<Function.v1beta1.Trigger>

• Create a trigger. Create a new trigger for a specified function.

  Parameters

  • request: Readonly<Function.v1beta1.CreateTriggerRequest>

    The request CreateTriggerRequest

  Returns Promise<Function.v1beta1.Trigger>

  A Promise of Trigger

deleteCron

• deleteCron(request): Promise<Function.v1beta1.Cron>

• Delete an existing cron. Delete the cron associated with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.DeleteCronRequest>

    The request DeleteCronRequest

  Returns Promise<Function.v1beta1.Cron>

  A Promise of Cron

deleteDomain

• deleteDomain(request): Promise<Function.v1beta1.Domain>

• Delete a domain name binding. Delete a domain name binding for the function with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.DeleteDomainRequest>

    The request DeleteDomainRequest

  Returns Promise<Function.v1beta1.Domain>

  A Promise of Domain

deleteFunction

• deleteFunction(request): Promise<Function>

• Delete a function. Delete the function associated with the specified ID.

  Parameters

  • request: Readonly<DeleteFunctionRequest>

    The request DeleteFunctionRequest

  Returns Promise<Function>

  A Promise of Function

deleteNamespace

• deleteNamespace(request): Promise<Function.v1beta1.Namespace>

• Delete an existing namespace. Delete the namespace associated with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.DeleteNamespaceRequest>

    The request DeleteNamespaceRequest

  Returns Promise<Function.v1beta1.Namespace>

  A Promise of Namespace

deleteToken

• deleteToken(request): Promise<Function.v1beta1.Token>

• Delete a token.

  Parameters

  • request: Readonly<Function.v1beta1.DeleteTokenRequest>

    The request DeleteTokenRequest

  Returns Promise<Function.v1beta1.Token>

  A Promise of Token

deleteTrigger

• deleteTrigger(request): Promise<Function.v1beta1.Trigger>

• Delete a trigger. Delete a trigger with a specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.DeleteTriggerRequest>

    The request DeleteTriggerRequest

  Returns Promise<Function.v1beta1.Trigger>

  A Promise of Trigger

deployFunction

• deployFunction(request): Promise<Function>

• Deploy a function. Deploy a function associated with the specified ID.

  Parameters

  • request: Readonly<DeployFunctionRequest>

    The request DeployFunctionRequest

  Returns Promise<Function>

  A Promise of Function

getCron

• getCron(request): Promise<Function.v1beta1.Cron>

• Get a cron. Get the cron associated with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.GetCronRequest>

    The request GetCronRequest

  Returns Promise<Function.v1beta1.Cron>

  A Promise of Cron

getDomain

• getDomain(request): Promise<Function.v1beta1.Domain>

• Get a domain name binding. Get a domain name binding for the function with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.GetDomainRequest>

    The request GetDomainRequest

  Returns Promise<Function.v1beta1.Domain>

  A Promise of Domain

getFunction

• getFunction(request): Promise<Function>

• Get a function. Get the function associated with the specified ID.

  Parameters

  • request: Readonly<GetFunctionRequest>

    The request GetFunctionRequest

  Returns Promise<Function>

  A Promise of Function

getFunctionDownloadURL

• getFunctionDownloadURL(request): Promise<DownloadURL>

• Get a download URL of a function. Get a download URL for a function associated with the specified ID.

  Parameters

  • request: Readonly<GetFunctionDownloadURLRequest>

    The request GetFunctionDownloadURLRequest

  Returns Promise<DownloadURL>

  A Promise of DownloadURL

getFunctionUploadURL

• getFunctionUploadURL(request): Promise<UploadURL>

• Get an upload URL of a function. Get an upload URL of a function associated with the specified ID.

  Parameters

  • request: Readonly<GetFunctionUploadURLRequest>

    The request GetFunctionUploadURLRequest

  Returns Promise<UploadURL>

  A Promise of UploadURL

getNamespace

• getNamespace(request): Promise<Function.v1beta1.Namespace>

• Get a namespace. Get the namespace associated with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.GetNamespaceRequest>

    The request GetNamespaceRequest

  Returns Promise<Function.v1beta1.Namespace>

  A Promise of Namespace

getToken

• getToken(request): Promise<Function.v1beta1.Token>

• Get a token.

  Parameters

  • request: Readonly<Function.v1beta1.GetTokenRequest>

    The request GetTokenRequest

  Returns Promise<Function.v1beta1.Token>

  A Promise of Token

getTrigger

• getTrigger(request): Promise<Function.v1beta1.Trigger>

• Get a trigger. Get a trigger with a specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.GetTriggerRequest>

    The request GetTriggerRequest

  Returns Promise<Function.v1beta1.Trigger>

  A Promise of Trigger

listCrons

• listCrons(request): Promise<Function.v1beta1.ListCronsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Cron[], void, void>);
      all: (() => Promise<Function.v1beta1.Cron[]>);
  }

• List all crons. List all the cronjobs in a specified region.

  Parameters

  • request: Readonly<Function.v1beta1.ListCronsRequest>

    The request ListCronsRequest

  Returns Promise<Function.v1beta1.ListCronsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Cron[], void, void>);
      all: (() => Promise<Function.v1beta1.Cron[]>);
  }

  A Promise of ListCronsResponse

listDomains

• listDomains(request): Promise<Function.v1beta1.ListDomainsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Domain[], void, void>);
      all: (() => Promise<Function.v1beta1.Domain[]>);
  }

• List all domain name bindings. List all domain name bindings in a specified region.

  Parameters

  • request: Readonly<Function.v1beta1.ListDomainsRequest>

    The request ListDomainsRequest

  Returns Promise<Function.v1beta1.ListDomainsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Domain[], void, void>);
      all: (() => Promise<Function.v1beta1.Domain[]>);
  }

  A Promise of ListDomainsResponse

listFunctionRuntimes

• listFunctionRuntimes(request?): Promise<ListFunctionRuntimesResponse>

• List function runtimes. List available function runtimes.

  Parameters

  • request: Readonly<ListFunctionRuntimesRequest> = {}

    The request ListFunctionRuntimesRequest

  Returns Promise<ListFunctionRuntimesResponse>

  A Promise of ListFunctionRuntimesResponse

listFunctions

• listFunctions(request): Promise<ListFunctionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function[], void, void>);
      all: (() => Promise<Function[]>);
  }

• List all your functions.

  Parameters

  • request: Readonly<ListFunctionsRequest>

    The request ListFunctionsRequest

  Returns Promise<ListFunctionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function[], void, void>);
      all: (() => Promise<Function[]>);
  }

  A Promise of ListFunctionsResponse

listNamespaces

• listNamespaces(request?): Promise<Function.v1beta1.ListNamespacesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Namespace[], void, void>);
      all: (() => Promise<Function.v1beta1.Namespace[]>);
  }

• List all your namespaces. List all existing namespaces in the specified region.

  Parameters

  • request: Readonly<Function.v1beta1.ListNamespacesRequest> = {}

    The request ListNamespacesRequest

  Returns Promise<Function.v1beta1.ListNamespacesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Namespace[], void, void>);
      all: (() => Promise<Function.v1beta1.Namespace[]>);
  }

  A Promise of ListNamespacesResponse

listTokens

• listTokens(request?): Promise<Function.v1beta1.ListTokensResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Token[], void, void>);
      all: (() => Promise<Function.v1beta1.Token[]>);
  }

• List all tokens.

  Parameters

  • request: Readonly<Function.v1beta1.ListTokensRequest> = {}

    The request ListTokensRequest

  Returns Promise<Function.v1beta1.ListTokensResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Token[], void, void>);
      all: (() => Promise<Function.v1beta1.Token[]>);
  }

  A Promise of ListTokensResponse

listTriggers

• listTriggers(request?): Promise<Function.v1beta1.ListTriggersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Trigger[], void, void>);
      all: (() => Promise<Function.v1beta1.Trigger[]>);
  }

• List all triggers. List all triggers belonging to a specified Organization or Project.

  Parameters

  • request: Readonly<Function.v1beta1.ListTriggersRequest> = {}

    The request ListTriggersRequest

  Returns Promise<Function.v1beta1.ListTriggersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Function.v1beta1.Trigger[], void, void>);
      all: (() => Promise<Function.v1beta1.Trigger[]>);
  }

  A Promise of ListTriggersResponse

updateCron

• updateCron(request): Promise<Function.v1beta1.Cron>

• Update an existing cron. Update the cron associated with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.UpdateCronRequest>

    The request UpdateCronRequest

  Returns Promise<Function.v1beta1.Cron>

  A Promise of Cron

updateFunction

• updateFunction(request): Promise<Function>

• Update an existing function. Update the function associated with the specified ID.

  Parameters

  • request: Readonly<UpdateFunctionRequest>

    The request UpdateFunctionRequest

  Returns Promise<Function>

  A Promise of Function

updateNamespace

• updateNamespace(request): Promise<Function.v1beta1.Namespace>

• Update an existing namespace. Update the namespace associated with the specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.UpdateNamespaceRequest>

    The request UpdateNamespaceRequest

  Returns Promise<Function.v1beta1.Namespace>

  A Promise of Namespace

updateTrigger

• updateTrigger(request): Promise<Function.v1beta1.Trigger>

• Update a trigger. Update a trigger with a specified ID.

  Parameters

  • request: Readonly<Function.v1beta1.UpdateTriggerRequest>

    The request UpdateTriggerRequest

  Returns Promise<Function.v1beta1.Trigger>

  A Promise of Trigger

waitForCron

• waitForCron(request, options?): Promise<Function.v1beta1.Cron>

• Waits for Cron to be in a final state.

  Parameters

  • request: Readonly<Function.v1beta1.GetCronRequest>

    The request GetCronRequest
  • Optionaloptions: Readonly<WaitForOptions<Function.v1beta1.Cron>>

    The waiting options

  Returns Promise<Function.v1beta1.Cron>

  A Promise of Cron

waitForDomain

• waitForDomain(request, options?): Promise<Function.v1beta1.Domain>

• Waits for Domain to be in a final state.

  Parameters

  • request: Readonly<Function.v1beta1.GetDomainRequest>

    The request GetDomainRequest
  • Optionaloptions: Readonly<WaitForOptions<Function.v1beta1.Domain>>

    The waiting options

  Returns Promise<Function.v1beta1.Domain>

  A Promise of Domain

waitForFunction

• waitForFunction(request, options?): Promise<Function>

• Waits for Function to be in a final state.

  Parameters

  • request: Readonly<GetFunctionRequest>

    The request GetFunctionRequest
  • Optionaloptions: Readonly<WaitForOptions<Function>>

    The waiting options

  Returns Promise<Function>

  A Promise of Function

waitForNamespace

• waitForNamespace(request, options?): Promise<Function.v1beta1.Namespace>

• Waits for Namespace to be in a final state.

  Parameters

  • request: Readonly<Function.v1beta1.GetNamespaceRequest>

    The request GetNamespaceRequest
  • Optionaloptions: Readonly<WaitForOptions<Function.v1beta1.Namespace>>

    The waiting options

  Returns Promise<Function.v1beta1.Namespace>

  A Promise of Namespace

waitForToken

• waitForToken(request, options?): Promise<Function.v1beta1.Token>

• Waits for Token to be in a final state.

  Parameters

  • request: Readonly<Function.v1beta1.GetTokenRequest>

    The request GetTokenRequest
  • Optionaloptions: Readonly<WaitForOptions<Function.v1beta1.Token>>

    The waiting options

  Returns Promise<Function.v1beta1.Token>

  A Promise of Token

waitForTrigger

• waitForTrigger(request, options?): Promise<Function.v1beta1.Trigger>

• Waits for Trigger to be in a final state.

  Parameters

  • request: Readonly<Function.v1beta1.GetTriggerRequest>

    The request GetTriggerRequest
  • Optionaloptions: Readonly<WaitForOptions<Function.v1beta1.Trigger>>

    The waiting options

  Returns Promise<Function.v1beta1.Trigger>

  A Promise of Trigger