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

    Interface WithGarbage_collection_uuItemRequestBuilder

    Builds and executes requests for operations under /v2/registry/{registry_name}/garbage-collection/{garbage_collection_uuid}

    interface WithGarbage_collection_uuItemRequestBuilder {
        put(
            body: Update_registry,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithGarbage_collection_uuPutResponse>;
        toPutRequestInformation(
            body: Update_registry,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithGarbage_collection_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    put toPutRequestInformation withUrl

    Methods

    • To cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below.

      Parameters

      • body: Update_registry

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithGarbage_collection_uuPutResponse>

      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 cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below.

      Parameters

      • body: Update_registry

        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