Function remove

See

https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Collections/#deleteCollection

  • remove(
        configuration: GCSConfiguration,
        collection_id: string,
        options?: { payload?: undefined; query?: undefined } & {
            headers?: Headers;
            query?: {
                [key: string]:
                    | undefined
                    | null
                    | string
                    | number
                    | boolean
                    | (undefined | null | string | number)[];
            };
        },
        sdkOptions?: SDKOptions,
    ): Promise<
        JSONFetchResponse<
            | {
                code: string;
                data?: Record<string, unknown>[];
                DATA_TYPE: "result#1.0.0";
                detail?: unknown;
                has_next_page?: boolean;
                http_response_code: number;
                marker?: null | string;
                message?: string;
            }
            | {
                authorization_parameters?: null
                | { [key: string]: unknown };
                code: string;
                data?: Record<string, unknown>[];
                DATA_TYPE: "result#1.1.0";
                detail?: unknown;
                has_next_page?: boolean;
                http_response_code: number;
                marker?: null | string;
                message?: string;
            },
        >,
    >

  • Parameters

    • configuration: GCSConfiguration
    • collection_id: string
    • Optionaloptions: { payload?: undefined; query?: undefined } & {
          headers?: Headers;
          query?: {
              [key: string]:
                  | undefined
                  | null
                  | string
                  | number
                  | boolean
                  | (undefined | null | string | number)[];
          };
      }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<
        JSONFetchResponse<
            | {
                code: string;
                data?: Record<string, unknown>[];
                DATA_TYPE: "result#1.0.0";
                detail?: unknown;
                has_next_page?: boolean;
                http_response_code: number;
                marker?: null | string;
                message?: string;
            }
            | {
                authorization_parameters?: null
                | { [key: string]: unknown };
                code: string;
                data?: Record<string, unknown>[];
                DATA_TYPE: "result#1.1.0";
                detail?: unknown;
                has_next_page?: boolean;
                http_response_code: number;
                marker?: null | string;
                message?: string;
            },
        >,
    >

Settings

Member Visibility