Function update

update(
    endpoint_xid: string,
    options?: { payload: Partial; query?: undefined } & {
        headers?: Headers;
        query?: {
            [key: string]:
                | undefined
                | null
                | string
                | number
                | boolean
                | (undefined | null | string | number)[];
        };
    },
    sdkOptions?: SDKOptions,
): Promise<
    JSONFetchResponse<
        {
            code: "Updated";
            DATA_TYPE: "result";
            message: string;
            request_id: string;
            resource: `/endpoint/${string}`;
        },
    >,
>
Update a Globus Connect Personal collection. As of 2024-04-17, this method (and the Transfer API) only supports updating Globus Connect Personal collections.

All GCSv5 collections should be updated using Globus Connect Server (i.e. gcs.collections.update).
Parameters
- endpoint_xid: string
- Optionaloptions: { payload: Partial; query?: undefined } & {
      headers?: Headers;
      query?: {
          [key: string]:
              | undefined
              | null
              | string
              | number
              | boolean
              | (undefined | null | string | number)[];
      };
  }
- OptionalsdkOptions: SDKOptions
Returns Promise<
    JSONFetchResponse<
        {
            code: "Updated";
            DATA_TYPE: "result";
            message: string;
            request_id: string;
            resource: `/endpoint/${string}`;
        },
    >,
>
See
https://docs.globus.org/api/transfer/gcp_management/#update_collection_by_id
- Defined in src/services/transfer/service/endpoint.ts:77

Function update

Parameters

Returns Promise< JSONFetchResponse< { code: "Updated"; DATA_TYPE: "result"; message: string; request_id: string; resource: `/endpoint/${string}`; }, >,>

See

Settings

Returns Promise<
JSONFetchResponse<
{
code: "Updated";
DATA_TYPE: "result";
message: string;
request_id: string;
resource: `/endpoint/${string}`;
},
>,
>