Interface WithAction_ItemRequestBuilder

Builds and executes requests for operations under /v2/volumes/{volume_id}/actions/{action_id}

interface WithAction_ItemRequestBuilder {
    get(
        requestConfiguration?: RequestConfiguration<
            WithAction_ItemRequestBuilderGetQueryParameters,
        >,
    ): Promise<undefined | WithAction_GetResponse>;
    toGetRequestInformation(
        requestConfiguration?: RequestConfiguration<
            WithAction_ItemRequestBuilderGetQueryParameters,
        >,
    ): RequestInformation;
    withUrl(rawUrl: string): WithAction_ItemRequestBuilder;
}

Hierarchy

BaseRequestBuilder<WithAction_ItemRequestBuilder>
- WithAction_ItemRequestBuilder

Index

Methods

get toGetRequestInformation withUrl

Methods

get

get(
    requestConfiguration?: RequestConfiguration<
        WithAction_ItemRequestBuilderGetQueryParameters,
    >,
): Promise<undefined | WithAction_GetResponse>
To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/actions/$ACTION_ID.
Parameters
- OptionalrequestConfiguration: RequestConfiguration<WithAction_ItemRequestBuilderGetQueryParameters>
  Configuration for the request such as headers, query parameters, and middleware options.
Returns Promise<undefined | WithAction_GetResponse>
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/volumes/item/actions/item/index.ts:61

toGetRequestInformation

toGetRequestInformation(
    requestConfiguration?: RequestConfiguration<
        WithAction_ItemRequestBuilderGetQueryParameters,
    >,
): RequestInformation
To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/actions/$ACTION_ID.
Parameters
- OptionalrequestConfiguration: RequestConfiguration<WithAction_ItemRequestBuilderGetQueryParameters>
  Configuration for the request such as headers, query parameters, and middleware options.
Returns RequestInformation
- Defined in src/dots/v2/volumes/item/actions/item/index.ts:67

withUrl

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