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

    Interface ClustersRequestBuilder

    Builds and executes requests for operations under /v2/kubernetes/clusters

    interface ClustersRequestBuilder {
        byCluster_id(cluster_id: string): WithCluster_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                ClustersRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ClustersGetResponse>;
        post(
            body: Cluster,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ClustersPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                ClustersRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Cluster,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ClustersRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byCluster_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Cluster,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ClustersPostResponse>

      To create a new Kubernetes cluster, send a POST request to/v2/kubernetes/clusters. The request must contain at least one node poolwith at least one worker.The request may contain a maintenance window policy describing a time periodwhen disruptive maintenance tasks may be carried out. Omitting the policyimplies that a window will be chosen automatically. Seeherefor details.

      Parameters

      • body: Cluster

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ClustersPostResponse>

      error when the service returns a 401 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 create a new Kubernetes cluster, send a POST request to/v2/kubernetes/clusters. The request must contain at least one node poolwith at least one worker.The request may contain a maintenance window policy describing a time periodwhen disruptive maintenance tasks may be carried out. Omitting the policyimplies that a window will be chosen automatically. Seeherefor details.

      Parameters

      • body: Cluster

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns ClustersRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods