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

    Interface RegistryRequestBuilder

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

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

    Hierarchy

    Index

    Methods

    delete post toDeleteRequestInformation toPostRequestInformation withUrl

    Methods

    • To remove the container registry from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registry.

      Parameters

      • body: Cluster_registries

        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 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: Cluster_registries,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<void>

      To integrate the container registry with Kubernetes clusters, send a POST request to /v2/kubernetes/registry.

      Parameters

      • body: Cluster_registries

        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 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 the container registry from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registry.

      Parameters

      • body: Cluster_registries

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To integrate the container registry with Kubernetes clusters, send a POST request to /v2/kubernetes/registry.

      Parameters

      • body: Cluster_registries

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns RegistryRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods