@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface WithLb_ItemRequestBuilder

    Builds and executes requests for operations under /v2/load_balancers/{lb_id}

    interface WithLb_ItemRequestBuilder {
        get cache(): CacheRequestBuilder;
        get droplets(): DropletsRequestBuilder;
        get forwarding_rules(): Forwarding_rulesRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithLb_GetResponse>;
        put(
            body: UntypedNode,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithLb_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: UntypedNode,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithLb_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    cache droplets forwarding_rules

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete a load balancer instance, disassociating any Droplets assigned to itand removing it from your account, send a DELETE request to/v2/load_balancers/$LOAD_BALANCER_ID.A successful request will receive a 204 status code with no body in response.This indicates that the request was processed successfully.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To show information about a load balancer instance, send a GET request to/v2/load_balancers/$LOAD_BALANCER_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | WithLb_GetResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To update a load balancer's settings, send a PUT request to/v2/load_balancers/$LOAD_BALANCER_ID. The request should contain a fullrepresentation of the load balancer including existing attributes. It maycontain one of the droplets_ids or tag attributes as they are mutuallyexclusive. Note that any attribute that is not provided will be reset to itsdefault value.

      Parameters

      • body: UntypedNode

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | WithLb_PutResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To delete a load balancer instance, disassociating any Droplets assigned to itand removing it from your account, send a DELETE request to/v2/load_balancers/$LOAD_BALANCER_ID.A successful request will receive a 204 status code with no body in response.This indicates that the request was processed successfully.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To show information about a load balancer instance, send a GET request to/v2/load_balancers/$LOAD_BALANCER_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To update a load balancer's settings, send a PUT request to/v2/load_balancers/$LOAD_BALANCER_ID. The request should contain a fullrepresentation of the load balancer including existing attributes. It maycontain one of the droplets_ids or tag attributes as they are mutuallyexclusive. Note that any attribute that is not provided will be reset to itsdefault value.

      Parameters

      • body: UntypedNode

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods