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

    Interface WithCluster_ItemRequestBuilder

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

    interface WithCluster_ItemRequestBuilder {
        get clusterlint(): ClusterlintRequestBuilder;
        get credentials(): CredentialsRequestBuilder;
        get destroy_with_associated_resources(): Destroy_with_associated_resourcesRequestBuilder;
        get kubeconfig(): KubeconfigRequestBuilder;
        get node_pools(): Node_poolsRequestBuilder;
        get status_messages(): Status_messagesRequestBuilder;
        get upgrade(): UpgradeRequestBuilder;
        get upgrades(): UpgradesRequestBuilder;
        get user(): UserRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithCluster_GetResponse>;
        put(
            body: Cluster_update,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithCluster_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Cluster_update,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithCluster_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    clusterlint credentials destroy_with_associated_resources kubeconfig node_pools status_messages upgrade upgrades user

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete a Kubernetes cluster and all services deployed to it, send a DELETErequest to /v2/kubernetes/clusters/$K8S_CLUSTER_ID.A 204 status code with no body will be returned in response to a successfulrequest.

      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 an existing Kubernetes cluster, send a GET requestto /v2/kubernetes/clusters/$K8S_CLUSTER_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithCluster_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 Kubernetes cluster, send a PUT request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of theattributes below.

      Parameters

      • body: Cluster_update

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithCluster_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 Kubernetes cluster and all services deployed to it, send a DELETErequest to /v2/kubernetes/clusters/$K8S_CLUSTER_ID.A 204 status code with no body will be returned in response to a successfulrequest.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To show information about an existing Kubernetes cluster, send a GET requestto /v2/kubernetes/clusters/$K8S_CLUSTER_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update a Kubernetes cluster, send a PUT request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of theattributes below.

      Parameters

      • body: Cluster_update

        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