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

    Interface Node_poolsRequestBuilder

    Builds and executes requests for operations under /v2/kubernetes/clusters/{cluster_id}/node_pools

    interface Node_poolsRequestBuilder {
        byNode_pool_id(node_pool_id: string): WithNode_pool_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Node_poolsGetResponse>;
        post(
            body: Kubernetes_node_pool,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Node_poolsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Kubernetes_node_pool,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Node_poolsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byNode_pool_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all of the node pools in a Kubernetes clusters, send a GET request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Node_poolsGetResponse>

      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: Kubernetes_node_pool,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Node_poolsPostResponse>

      To add an additional node pool to a Kubernetes clusters, send a POST requestto /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools with the followingattributes.

      Parameters

      • body: Kubernetes_node_pool

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Node_poolsPostResponse>

      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 list all of the node pools in a Kubernetes clusters, send a GET request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To add an additional node pool to a Kubernetes clusters, send a POST requestto /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools with the followingattributes.

      Parameters

      • body: Kubernetes_node_pool

        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