Class API

constructor

• new API(client): LB.v1.API

• Parameters

  • client: Client

  Returns LB.v1.API

Static ReadonlyLOCALITIES

addBackendServers

• addBackendServers(request): Promise<Backend>

• Add a set of servers in a given backend.

  Parameters

  • request: Readonly<AddBackendServersRequest>

    The request AddBackendServersRequest

  Returns Promise<Backend>

  A Promise of Backend

attachPrivateNetwork

• attachPrivateNetwork(request): Promise<LB.v1.PrivateNetwork>

• Add load balancer on instance private network.

  Parameters

  • request: Readonly<AttachPrivateNetworkRequest>

    The request AttachPrivateNetworkRequest

  Returns Promise<LB.v1.PrivateNetwork>

  A Promise of PrivateNetwork

createAcl

• createAcl(request): Promise<Acl>

• Create an ACL for a given frontend.

  Parameters

  • request: Readonly<CreateAclRequest>

    The request CreateAclRequest

  Returns Promise<Acl>

  A Promise of Acl

createBackend

• createBackend(request): Promise<Backend>

• Create a backend in a given load balancer.

  Parameters

  • request: Readonly<CreateBackendRequest>

    The request CreateBackendRequest

  Returns Promise<Backend>

  A Promise of Backend

createCertificate

• createCertificate(request): Promise<LB.v1.Certificate>

• Create a TLS certificate. Generate a new TLS certificate using Let's Encrypt or import your certificate.

  Parameters

  • request: Readonly<CreateCertificateRequest>

    The request CreateCertificateRequest

  Returns Promise<LB.v1.Certificate>

  A Promise of Certificate

createFrontend

• createFrontend(request): Promise<Frontend>

• Create a frontend in a given load balancer.

  Parameters

  • request: Readonly<CreateFrontendRequest>

    The request CreateFrontendRequest

  Returns Promise<Frontend>

  A Promise of Frontend

createIp

• createIp(request): Promise<LB.v1.Ip>

• Create an IP.

  Parameters

  • request: Readonly<LB.v1.CreateIpRequest>

    The request CreateIpRequest

  Returns Promise<LB.v1.Ip>

  A Promise of Ip

createLb

• createLb(request): Promise<Lb>

• Create a load balancer.

  Parameters

  • request: Readonly<CreateLbRequest>

    The request CreateLbRequest

  Returns Promise<Lb>

  A Promise of Lb

createRoute

• createRoute(request): Promise<LB.v1.Route>

• Create a backend redirection.

  Parameters

  • request: Readonly<LB.v1.CreateRouteRequest>

    The request CreateRouteRequest

  Returns Promise<LB.v1.Route>

  A Promise of Route

createSubscriber

• createSubscriber(request): Promise<Subscriber>

• Create a subscriber, webhook or email.

  Parameters

  • request: Readonly<CreateSubscriberRequest>

    The request CreateSubscriberRequest

  Returns Promise<Subscriber>

  A Promise of Subscriber

deleteAcl

• deleteAcl(request): Promise<void>

• Delete an ACL.

  Parameters

  • request: Readonly<DeleteAclRequest>

    The request DeleteAclRequest

  Returns Promise<void>

deleteBackend

• deleteBackend(request): Promise<void>

• Delete a backend in a given load balancer.

  Parameters

  • request: Readonly<DeleteBackendRequest>

    The request DeleteBackendRequest

  Returns Promise<void>

deleteCertificate

• deleteCertificate(request): Promise<void>

• Delete a TLS certificate.

  Parameters

  • request: Readonly<DeleteCertificateRequest>

    The request DeleteCertificateRequest

  Returns Promise<void>

deleteFrontend

• deleteFrontend(request): Promise<void>

• Delete a frontend.

  Parameters

  • request: Readonly<DeleteFrontendRequest>

    The request DeleteFrontendRequest

  Returns Promise<void>

deleteLb

• deleteLb(request): Promise<void>

• Delete a load balancer.

  Parameters

  • request: Readonly<DeleteLbRequest>

    The request DeleteLbRequest

  Returns Promise<void>

deleteRoute

• deleteRoute(request): Promise<void>

• Delete a backend redirection.

  Parameters

  • request: Readonly<LB.v1.DeleteRouteRequest>

    The request DeleteRouteRequest

  Returns Promise<void>

deleteSubscriber

• deleteSubscriber(request): Promise<void>

• Delete a subscriber.

  Parameters

  • request: Readonly<DeleteSubscriberRequest>

    The request DeleteSubscriberRequest

  Returns Promise<void>

detachPrivateNetwork

• detachPrivateNetwork(request): Promise<void>

• Remove load balancer of private network.

  Parameters

  • request: Readonly<DetachPrivateNetworkRequest>

    The request DetachPrivateNetworkRequest

  Returns Promise<void>

getAcl

• getAcl(request): Promise<Acl>

• Get an ACL.

  Parameters

  • request: Readonly<GetAclRequest>

    The request GetAclRequest

  Returns Promise<Acl>

  A Promise of Acl

getBackend

• getBackend(request): Promise<Backend>

• Get a backend in a given load balancer.

  Parameters

  • request: Readonly<GetBackendRequest>

    The request GetBackendRequest

  Returns Promise<Backend>

  A Promise of Backend

getCertificate

• getCertificate(request): Promise<LB.v1.Certificate>

• Get a TLS certificate.

  Parameters

  • request: Readonly<GetCertificateRequest>

    The request GetCertificateRequest

  Returns Promise<LB.v1.Certificate>

  A Promise of Certificate

getFrontend

• getFrontend(request): Promise<Frontend>

• Get a frontend.

  Parameters

  • request: Readonly<GetFrontendRequest>

    The request GetFrontendRequest

  Returns Promise<Frontend>

  A Promise of Frontend

getIp

• getIp(request): Promise<LB.v1.Ip>

• Get an IP.

  Parameters

  • request: Readonly<LB.v1.GetIpRequest>

    The request GetIpRequest

  Returns Promise<LB.v1.Ip>

  A Promise of Ip

getLb

• getLb(request): Promise<Lb>

• Get a load balancer.

  Parameters

  • request: Readonly<GetLbRequest>

    The request GetLbRequest

  Returns Promise<Lb>

  A Promise of Lb

getLbStats

• getLbStats(request): Promise<LbStats>

• Get usage statistics of a given load balancer.

  Parameters

  • request: Readonly<GetLbStatsRequest>

    The request GetLbStatsRequest

  Returns Promise<LbStats>

  A Promise of LbStats

  Deprecated

getRoute

• getRoute(request): Promise<LB.v1.Route>

• Get single backend redirection.

  Parameters

  • request: Readonly<LB.v1.GetRouteRequest>

    The request GetRouteRequest

  Returns Promise<LB.v1.Route>

  A Promise of Route

getSubscriber

• getSubscriber(request): Promise<Subscriber>

• Get a subscriber.

  Parameters

  • request: Readonly<GetSubscriberRequest>

    The request GetSubscriberRequest

  Returns Promise<Subscriber>

  A Promise of Subscriber

listAcls

• listAcls(request): Promise<ListAclResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Acl[], void, void>);
      all: (() => Promise<Acl[]>);
  }

• List ACL for a given frontend.

  Parameters

  • request: Readonly<ListAclsRequest>

    The request ListAclsRequest

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

  A Promise of ListAclResponse

listBackendStats

• listBackendStats(request): Promise<ListBackendStatsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<BackendServerStats[], void, void>);
      all: (() => Promise<BackendServerStats[]>);
  }

• List backend server statistics.

  Parameters

  • request: Readonly<ListBackendStatsRequest>

    The request ListBackendStatsRequest

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

  A Promise of ListBackendStatsResponse

listBackends

• listBackends(request): Promise<ListBackendsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Backend[], void, void>);
      all: (() => Promise<Backend[]>);
  }

• List backends in a given load balancer.

  Parameters

  • request: Readonly<ListBackendsRequest>

    The request ListBackendsRequest

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

  A Promise of ListBackendsResponse

listCertificates

• listCertificates(request): Promise<ListCertificatesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LB.v1.Certificate[], void, void>);
      all: (() => Promise<LB.v1.Certificate[]>);
  }

• List all TLS certificates on a given load balancer.

  Parameters

  • request: Readonly<ListCertificatesRequest>

    The request ListCertificatesRequest

  Returns Promise<ListCertificatesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LB.v1.Certificate[], void, void>);
      all: (() => Promise<LB.v1.Certificate[]>);
  }

  A Promise of ListCertificatesResponse

listFrontends

• listFrontends(request): Promise<ListFrontendsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Frontend[], void, void>);
      all: (() => Promise<Frontend[]>);
  }

• List frontends in a given load balancer.

  Parameters

  • request: Readonly<ListFrontendsRequest>

    The request ListFrontendsRequest

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

  A Promise of ListFrontendsResponse

listIPs

• listIPs(request?): Promise<LB.v1.ListIpsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LB.v1.Ip[], void, void>);
      all: (() => Promise<LB.v1.Ip[]>);
  }

• List IPs.

  Parameters

  • request: Readonly<LB.v1.ListIPsRequest> = {}

    The request ListIPsRequest

  Returns Promise<LB.v1.ListIpsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LB.v1.Ip[], void, void>);
      all: (() => Promise<LB.v1.Ip[]>);
  }

  A Promise of ListIpsResponse

listLbPrivateNetworks

• listLbPrivateNetworks(request): Promise<ListLbPrivateNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LB.v1.PrivateNetwork[], void, void>);
      all: (() => Promise<LB.v1.PrivateNetwork[]>);
  }

• List attached private network of load balancer.

  Parameters

  • request: Readonly<ListLbPrivateNetworksRequest>

    The request ListLbPrivateNetworksRequest

  Returns Promise<ListLbPrivateNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LB.v1.PrivateNetwork[], void, void>);
      all: (() => Promise<LB.v1.PrivateNetwork[]>);
  }

  A Promise of ListLbPrivateNetworksResponse

listLbTypes

• listLbTypes(request?): Promise<ListLbTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LbType[], void, void>);
      all: (() => Promise<LbType[]>);
  }

• List all load balancer offer type.

  Parameters

  • request: Readonly<ListLbTypesRequest> = {}

    The request ListLbTypesRequest

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

  A Promise of ListLbTypesResponse

listLbs

• listLbs(request?): Promise<ListLbsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Lb[], void, void>);
      all: (() => Promise<Lb[]>);
  }

• List load balancers.

  Parameters

  • request: Readonly<ListLbsRequest> = {}

    The request ListLbsRequest

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

  A Promise of ListLbsResponse

listRoutes

• listRoutes(request?): Promise<LB.v1.ListRoutesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LB.v1.Route[], void, void>);
      all: (() => Promise<LB.v1.Route[]>);
  }

• List all backend redirections.

  Parameters

  • request: Readonly<LB.v1.ListRoutesRequest> = {}

    The request ListRoutesRequest

  Returns Promise<LB.v1.ListRoutesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<LB.v1.Route[], void, void>);
      all: (() => Promise<LB.v1.Route[]>);
  }

  A Promise of ListRoutesResponse

listSubscriber

• listSubscriber(request?): Promise<ListSubscriberResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Subscriber[], void, void>);
      all: (() => Promise<Subscriber[]>);
  }

• List all subscriber.

  Parameters

  • request: Readonly<ListSubscriberRequest> = {}

    The request ListSubscriberRequest

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

  A Promise of ListSubscriberResponse

migrateLb

• migrateLb(request): Promise<Lb>

• Migrate a load balancer.

  Parameters

  • request: Readonly<MigrateLbRequest>

    The request MigrateLbRequest

  Returns Promise<Lb>

  A Promise of Lb

releaseIp

• releaseIp(request): Promise<void>

• Delete an IP.

  Parameters

  • request: Readonly<ReleaseIpRequest>

    The request ReleaseIpRequest

  Returns Promise<void>

removeBackendServers

• removeBackendServers(request): Promise<Backend>

• Remove a set of servers for a given backend.

  Parameters

  • request: Readonly<RemoveBackendServersRequest>

    The request RemoveBackendServersRequest

  Returns Promise<Backend>

  A Promise of Backend

setBackendServers

• setBackendServers(request): Promise<Backend>

• Define all servers in a given backend.

  Parameters

  • request: Readonly<SetBackendServersRequest>

    The request SetBackendServersRequest

  Returns Promise<Backend>

  A Promise of Backend

subscribeToLb

• subscribeToLb(request): Promise<Lb>

• Subscribe a subscriber to a given load balancer.

  Parameters

  • request: Readonly<SubscribeToLbRequest>

    The request SubscribeToLbRequest

  Returns Promise<Lb>

  A Promise of Lb

unsubscribeFromLb

• unsubscribeFromLb(request): Promise<Lb>

• Unsubscribe a subscriber from a given load balancer.

  Parameters

  • request: Readonly<UnsubscribeFromLbRequest>

    The request UnsubscribeFromLbRequest

  Returns Promise<Lb>

  A Promise of Lb

updateAcl

• updateAcl(request): Promise<Acl>

• Update an ACL.

  Parameters

  • request: Readonly<UpdateAclRequest>

    The request UpdateAclRequest

  Returns Promise<Acl>

  A Promise of Acl

updateBackend

• updateBackend(request): Promise<Backend>

• Update a backend in a given load balancer.

  Parameters

  • request: Readonly<UpdateBackendRequest>

    The request UpdateBackendRequest

  Returns Promise<Backend>

  A Promise of Backend

updateCertificate

• updateCertificate(request): Promise<LB.v1.Certificate>

• Update a TLS certificate.

  Parameters

  • request: Readonly<UpdateCertificateRequest>

    The request UpdateCertificateRequest

  Returns Promise<LB.v1.Certificate>

  A Promise of Certificate

updateFrontend

• updateFrontend(request): Promise<Frontend>

• Update a frontend.

  Parameters

  • request: Readonly<UpdateFrontendRequest>

    The request UpdateFrontendRequest

  Returns Promise<Frontend>

  A Promise of Frontend

updateHealthCheck

• updateHealthCheck(request): Promise<HealthCheck>

• Update an health check for a given backend.

  Parameters

  • request: Readonly<UpdateHealthCheckRequest>

    The request UpdateHealthCheckRequest

  Returns Promise<HealthCheck>

  A Promise of HealthCheck

updateIp

• updateIp(request): Promise<LB.v1.Ip>

• Update an IP.

  Parameters

  • request: Readonly<LB.v1.UpdateIpRequest>

    The request UpdateIpRequest

  Returns Promise<LB.v1.Ip>

  A Promise of Ip

updateLb

• updateLb(request): Promise<Lb>

• Update a load balancer.

  Parameters

  • request: Readonly<UpdateLbRequest>

    The request UpdateLbRequest

  Returns Promise<Lb>

  A Promise of Lb

updateRoute

• updateRoute(request): Promise<LB.v1.Route>

• Edit a backend redirection.

  Parameters

  • request: Readonly<LB.v1.UpdateRouteRequest>

    The request UpdateRouteRequest

  Returns Promise<LB.v1.Route>

  A Promise of Route

updateSubscriber

• updateSubscriber(request): Promise<Subscriber>

• Update a subscriber.

  Parameters

  • request: Readonly<UpdateSubscriberRequest>

    The request UpdateSubscriberRequest

  Returns Promise<Subscriber>

  A Promise of Subscriber

waitForCertificate

• waitForCertificate(request, options?): Promise<LB.v1.Certificate>

• Waits for Certificate to be in a final state.

  Parameters

  • request: Readonly<GetCertificateRequest>

    The request GetCertificateRequest
  • Optionaloptions: Readonly<WaitForOptions<LB.v1.Certificate>>

    The waiting options

  Returns Promise<LB.v1.Certificate>

  A Promise of Certificate

waitForLb

• waitForLb(request, options?): Promise<Lb>

• Waits for Lb to be in a final state.

  Parameters

  • request: Readonly<GetLbRequest>

    The request GetLbRequest
  • Optionaloptions: Readonly<WaitForOptions<Lb>>

    The waiting options

  Returns Promise<Lb>

  A Promise of Lb

waitForLbInstances

• waitForLbInstances(request, options?): Promise<Lb>

• Waits for all instances of a load balancer to be in a final state.

  Parameters

  • request: Readonly<GetLbRequest>

    The request GetLbRequest
  • Optionaloptions: Readonly<WaitForOptions<Lb>>

    The waiting options

  Returns Promise<Lb>

  A Promise of Lb

waitForLbPrivateNetworks

• waitForLbPrivateNetworks(request, options?): Promise<ListLbPrivateNetworksResponse>

• Waits for all private networks of a load balancer to be in a final state.

  Parameters

  • request: Readonly<WaitForLbPrivateNetworksRequest>

    The request WaitForLbPrivateNetworksRequest
  • Optionaloptions: Readonly<WaitForOptions<LB.v1.PrivateNetwork>>

    The waiting options

  Returns Promise<ListLbPrivateNetworksResponse>

  A Promise of ListLbPrivateNetworksResponse