Class API

constructor

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

• Parameters

  • client: Client

  Returns Container.v1beta1.API

Static ReadonlyLOCALITIES

createContainer

• createContainer(request): Promise<Container>

• Create a new container. Create a new container in the specified region.

  Parameters

  • request: Readonly<CreateContainerRequest>

    The request CreateContainerRequest

  Returns Promise<Container>

  A Promise of Container

createCron

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

• Create a new cron.

  Parameters

  • request: Readonly<Container.v1beta1.CreateCronRequest>

    The request CreateCronRequest

  Returns Promise<Container.v1beta1.Cron>

  A Promise of Cron

createDomain

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

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

  Parameters

  • request: Readonly<Container.v1beta1.CreateDomainRequest>

    The request CreateDomainRequest

  Returns Promise<Container.v1beta1.Domain>

  A Promise of Domain

createNamespace

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

• Create a new namespace. Create a new namespace in a specified region.

  Parameters

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

    The request CreateNamespaceRequest

  Returns Promise<Container.v1beta1.Namespace>

  A Promise of Namespace

createToken

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

• Create a new revocable token.

  Parameters

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

    The request CreateTokenRequest

  Returns Promise<Container.v1beta1.Token>

  A Promise of Token

createTrigger

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

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

  Parameters

  • request: Readonly<Container.v1beta1.CreateTriggerRequest>

    The request CreateTriggerRequest

  Returns Promise<Container.v1beta1.Trigger>

  A Promise of Trigger

deleteContainer

• deleteContainer(request): Promise<Container>

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

  Parameters

  • request: Readonly<DeleteContainerRequest>

    The request DeleteContainerRequest

  Returns Promise<Container>

  A Promise of Container

deleteCron

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

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

  Parameters

  • request: Readonly<Container.v1beta1.DeleteCronRequest>

    The request DeleteCronRequest

  Returns Promise<Container.v1beta1.Cron>

  A Promise of Cron

deleteDomain

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

• Delete a domain name binding. Delete the domain name binding with the specific ID.

  Parameters

  • request: Readonly<Container.v1beta1.DeleteDomainRequest>

    The request DeleteDomainRequest

  Returns Promise<Container.v1beta1.Domain>

  A Promise of Domain

deleteNamespace

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

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

  Parameters

  • request: Readonly<Container.v1beta1.DeleteNamespaceRequest>

    The request DeleteNamespaceRequest

  Returns Promise<Container.v1beta1.Namespace>

  A Promise of Namespace

deleteToken

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

• Delete a token. Delete a token with a specified ID.

  Parameters

  • request: Readonly<Container.v1beta1.DeleteTokenRequest>

    The request DeleteTokenRequest

  Returns Promise<Container.v1beta1.Token>

  A Promise of Token

deleteTrigger

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

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

  Parameters

  • request: Readonly<Container.v1beta1.DeleteTriggerRequest>

    The request DeleteTriggerRequest

  Returns Promise<Container.v1beta1.Trigger>

  A Promise of Trigger

deployContainer

• deployContainer(request): Promise<Container>

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

  Parameters

  • request: Readonly<DeployContainerRequest>

    The request DeployContainerRequest

  Returns Promise<Container>

  A Promise of Container

getContainer

• getContainer(request): Promise<Container>

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

  Parameters

  • request: Readonly<GetContainerRequest>

    The request GetContainerRequest

  Returns Promise<Container>

  A Promise of Container

getCron

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

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

  Parameters

  • request: Readonly<Container.v1beta1.GetCronRequest>

    The request GetCronRequest

  Returns Promise<Container.v1beta1.Cron>

  A Promise of Cron

getDomain

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

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

  Parameters

  • request: Readonly<Container.v1beta1.GetDomainRequest>

    The request GetDomainRequest

  Returns Promise<Container.v1beta1.Domain>

  A Promise of Domain

getNamespace

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

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

  Parameters

  • request: Readonly<Container.v1beta1.GetNamespaceRequest>

    The request GetNamespaceRequest

  Returns Promise<Container.v1beta1.Namespace>

  A Promise of Namespace

getToken

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

• Get a token. Get a token with a specified ID.

  Parameters

  • request: Readonly<Container.v1beta1.GetTokenRequest>

    The request GetTokenRequest

  Returns Promise<Container.v1beta1.Token>

  A Promise of Token

getTrigger

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

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

  Parameters

  • request: Readonly<Container.v1beta1.GetTriggerRequest>

    The request GetTriggerRequest

  Returns Promise<Container.v1beta1.Trigger>

  A Promise of Trigger

listContainers

• listContainers(request): Promise<ListContainersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Container[], void, void>);
      all: (() => Promise<Container[]>);
  }

• List all your containers. List all containers for a specified region.

  Parameters

  • request: Readonly<ListContainersRequest>

    The request ListContainersRequest

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

  A Promise of ListContainersResponse

listCrons

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

• List all your crons.

  Parameters

  • request: Readonly<Container.v1beta1.ListCronsRequest>

    The request ListCronsRequest

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

  A Promise of ListCronsResponse

listDomains

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

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

  Parameters

  • request: Readonly<Container.v1beta1.ListDomainsRequest>

    The request ListDomainsRequest

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

  A Promise of ListDomainsResponse

listNamespaces

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

• List all your namespaces. List all namespaces in a specified region.

  Parameters

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

    The request ListNamespacesRequest

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

  A Promise of ListNamespacesResponse

listTokens

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

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

  Parameters

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

    The request ListTokensRequest

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

  A Promise of ListTokensResponse

listTriggers

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

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

  Parameters

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

    The request ListTriggersRequest

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

  A Promise of ListTriggersResponse

updateContainer

• updateContainer(request): Promise<Container>

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

  Parameters

  • request: Readonly<UpdateContainerRequest>

    The request UpdateContainerRequest

  Returns Promise<Container>

  A Promise of Container

updateCron

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

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

  Parameters

  • request: Readonly<Container.v1beta1.UpdateCronRequest>

    The request UpdateCronRequest

  Returns Promise<Container.v1beta1.Cron>

  A Promise of Cron

updateNamespace

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

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

  Parameters

  • request: Readonly<Container.v1beta1.UpdateNamespaceRequest>

    The request UpdateNamespaceRequest

  Returns Promise<Container.v1beta1.Namespace>

  A Promise of Namespace

updateTrigger

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

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

  Parameters

  • request: Readonly<Container.v1beta1.UpdateTriggerRequest>

    The request UpdateTriggerRequest

  Returns Promise<Container.v1beta1.Trigger>

  A Promise of Trigger

waitForContainer

• waitForContainer(request, options?): Promise<Container>

• Waits for Container to be in a final state.

  Parameters

  • request: Readonly<GetContainerRequest>

    The request GetContainerRequest
  • Optionaloptions: Readonly<WaitForOptions<Container>>

    The waiting options

  Returns Promise<Container>

  A Promise of Container

waitForCron

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

• Waits for Cron to be in a final state.

  Parameters

  • request: Readonly<Container.v1beta1.GetCronRequest>

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

    The waiting options

  Returns Promise<Container.v1beta1.Cron>

  A Promise of Cron

waitForDomain

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

• Waits for Domain to be in a final state.

  Parameters

  • request: Readonly<Container.v1beta1.GetDomainRequest>

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

    The waiting options

  Returns Promise<Container.v1beta1.Domain>

  A Promise of Domain

waitForNamespace

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

• Waits for Namespace to be in a final state.

  Parameters

  • request: Readonly<Container.v1beta1.GetNamespaceRequest>

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

    The waiting options

  Returns Promise<Container.v1beta1.Namespace>

  A Promise of Namespace

waitForToken

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

• Waits for Token to be in a final state.

  Parameters

  • request: Readonly<Container.v1beta1.GetTokenRequest>

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

    The waiting options

  Returns Promise<Container.v1beta1.Token>

  A Promise of Token

waitForTrigger

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

• Waits for Trigger to be in a final state.

  Parameters

  • request: Readonly<Container.v1beta1.GetTriggerRequest>

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

    The waiting options

  Returns Promise<Container.v1beta1.Trigger>

  A Promise of Trigger