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

    Interface SelectiveRequestBuilder

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

    interface SelectiveRequestBuilder {
        delete(
            body: Destroy_associated_kubernetes_resources,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toDeleteRequestInformation(
            body: Destroy_associated_kubernetes_resources,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): SelectiveRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete toDeleteRequestInformation withUrl

    Methods

    • To delete a Kubernetes cluster along with a subset of its associated resources,send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/selective.The JSON body of the request should include load_balancers, volumes, orvolume_snapshots keys each set to an array of IDs for the associatedresources to be destroyed.The IDs can be found by querying the cluster's associated resources endpoint.Any associated resource not included in the request will remain and continueto accrue changes on your account.

      Parameters

      • body: Destroy_associated_kubernetes_resources

        An object containing the IDs of resources to be destroyed along with their associated with a Kubernetes cluster.

      • 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 delete a Kubernetes cluster along with a subset of its associated resources,send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/selective.The JSON body of the request should include load_balancers, volumes, orvolume_snapshots keys each set to an array of IDs for the associatedresources to be destroyed.The IDs can be found by querying the cluster's associated resources endpoint.Any associated resource not included in the request will remain and continueto accrue changes on your account.

      Parameters

      • body: Destroy_associated_kubernetes_resources

        An object containing the IDs of resources to be destroyed along with their associated with a Kubernetes cluster.

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns SelectiveRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods