Interface GarbageCollectionsRequestBuilder

Builds and executes requests for operations under /v2/registries/{registry_name}/garbage-collections

interface GarbageCollectionsRequestBuilder {
    get(
        requestConfiguration?: RequestConfiguration<
            GarbageCollectionsRequestBuilderGetQueryParameters,
        >,
    ): Promise<undefined | GarbageCollectionsGetResponse>;
    toGetRequestInformation(
        requestConfiguration?: RequestConfiguration<
            GarbageCollectionsRequestBuilderGetQueryParameters,
        >,
    ): RequestInformation;
    withUrl(rawUrl: string): GarbageCollectionsRequestBuilder;
}

Hierarchy

BaseRequestBuilder<GarbageCollectionsRequestBuilder>
- GarbageCollectionsRequestBuilder

Index

Methods

get toGetRequestInformation withUrl

Methods

get

get(
    requestConfiguration?: RequestConfiguration<
        GarbageCollectionsRequestBuilderGetQueryParameters,
    >,
): Promise<undefined | GarbageCollectionsGetResponse>
To get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collections.
Parameters
- OptionalrequestConfiguration: RequestConfiguration<GarbageCollectionsRequestBuilderGetQueryParameters>
  Configuration for the request such as headers, query parameters, and middleware options.
Returns Promise<undefined | GarbageCollectionsGetResponse>
Throws
error when the service returns a 401 status code

Throws
error when the service returns a 404 status code

Throws
error when the service returns a 429 status code

Throws
error when the service returns a 500 status code

Throws
error when the service returns a 4XX or 5XX status code
- Defined in src/dots/v2/registries/item/garbageCollections/index.ts:49

toGetRequestInformation

toGetRequestInformation(
    requestConfiguration?: RequestConfiguration<
        GarbageCollectionsRequestBuilderGetQueryParameters,
    >,
): RequestInformation
To get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collections.
Parameters
- OptionalrequestConfiguration: RequestConfiguration<GarbageCollectionsRequestBuilderGetQueryParameters>
  Configuration for the request such as headers, query parameters, and middleware options.
Returns RequestInformation
- Defined in src/dots/v2/registries/item/garbageCollections/index.ts:55

withUrl

withUrl(rawUrl: string): GarbageCollectionsRequestBuilder
Parameters
- rawUrl: string
Returns GarbageCollectionsRequestBuilder
Inherited from BaseRequestBuilder.withUrl
- Defined in node_modules/@microsoft/kiota-abstractions/dist/es/src/baseRequestBuilder.d.ts:8