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

    Interface Forwarding_rulesRequestBuilder

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

    interface Forwarding_rulesRequestBuilder {
        delete(
            body: Forwarding_rulesDeleteRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        post(
            body: Forwarding_rulesPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toDeleteRequestInformation(
            body: Forwarding_rulesDeleteRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Forwarding_rulesPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Forwarding_rulesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete post toDeleteRequestInformation toPostRequestInformation withUrl

    Methods

    • To remove forwarding rules from a load balancer instance, send a DELETErequest to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In thebody of the request, there should be a forwarding_rules attribute containingan array of rules to be removed.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • body: Forwarding_rulesDeleteRequestBody

        The request body

      • 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

    post

    • post(
          body: Forwarding_rulesPostRequestBody,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<void>

      To add an additional forwarding rule to a load balancer instance, send a POSTrequest to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the bodyof the request, there should be a forwarding_rules attribute containing anarray of rules to be added.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • body: Forwarding_rulesPostRequestBody

        The request body

      • 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 remove forwarding rules from a load balancer instance, send a DELETErequest to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In thebody of the request, there should be a forwarding_rules attribute containingan array of rules to be removed.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • body: Forwarding_rulesDeleteRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To add an additional forwarding rule to a load balancer instance, send a POSTrequest to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the bodyof the request, there should be a forwarding_rules attribute containing anarray of rules to be added.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • body: Forwarding_rulesPostRequestBody

        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

    Methods