Function update

See

https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Nodes/#putNode

  • update(
        configuration: GCSConfiguration,
        node_id: string,
        options:
            | undefined
            | {
                payload: | {
                    DATA_TYPE: "node#1.0.0";
                    id?: string;
                    incoming_port_range?: number[];
                    ip_addresses: string[];
                    outgoing_port_range?: number[];
                    status: "active"
                    | "inactive";
                }
                | {
                    data_interface?: null
                    | string;
                    DATA_TYPE: "node#1.1.0";
                    id?: string;
                    incoming_port_range?: number[];
                    ip_addresses: string[];
                    outgoing_port_range?: number[];
                    status: "active" | "inactive";
                }
                | {
                    data_interface?: null
                    | string;
                    data_interface6?: null | string;
                    DATA_TYPE: "node#1.2.0";
                    id?: string;
                    incoming_port_range?: number[];
                    ip_addresses: string[];
                    outgoing_port_range?: number[];
                    status: "active" | "inactive";
                };
            } & {
                headers?: Headers;
                query?: {
                    [key: string]: | undefined
                    | null
                    | string
                    | number
                    | boolean
                    | (undefined | null | string | number)[];
                };
            },
        sdkOptions?: SDKOptions,
    ): Promise<
        JSONFetchResponse<
            {
                code?: "success";
                data?: (
                    | {
                        DATA_TYPE: "node#1.0.0";
                        id?: string;
                        incoming_port_range?: number[];
                        ip_addresses: string[];
                        outgoing_port_range?: number[];
                        status: "active"
                        | "inactive";
                    }
                    | {
                        data_interface?: null
                        | string;
                        DATA_TYPE: "node#1.1.0";
                        id?: string;
                        incoming_port_range?: number[];
                        ip_addresses: string[];
                        outgoing_port_range?: number[];
                        status: "active" | "inactive";
                    }
                    | {
                        data_interface?: null
                        | string;
                        data_interface6?: null | string;
                        DATA_TYPE: "node#1.2.0";
                        id?: string;
                        incoming_port_range?: number[];
                        ip_addresses: string[];
                        outgoing_port_range?: number[];
                        status: "active" | "inactive";
                    }
                )[];
            } & (
                | {
                    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
    • node_id: string
    • options:
          | undefined
          | {
              payload: | {
                  DATA_TYPE: "node#1.0.0";
                  id?: string;
                  incoming_port_range?: number[];
                  ip_addresses: string[];
                  outgoing_port_range?: number[];
                  status: "active"
                  | "inactive";
              }
              | {
                  data_interface?: null
                  | string;
                  DATA_TYPE: "node#1.1.0";
                  id?: string;
                  incoming_port_range?: number[];
                  ip_addresses: string[];
                  outgoing_port_range?: number[];
                  status: "active" | "inactive";
              }
              | {
                  data_interface?: null
                  | string;
                  data_interface6?: null | string;
                  DATA_TYPE: "node#1.2.0";
                  id?: string;
                  incoming_port_range?: number[];
                  ip_addresses: string[];
                  outgoing_port_range?: number[];
                  status: "active" | "inactive";
              };
          } & {
              headers?: Headers;
              query?: {
                  [key: string]: | undefined
                  | null
                  | string
                  | number
                  | boolean
                  | (undefined | null | string | number)[];
              };
          }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<
        JSONFetchResponse<
            {
                code?: "success";
                data?: (
                    | {
                        DATA_TYPE: "node#1.0.0";
                        id?: string;
                        incoming_port_range?: number[];
                        ip_addresses: string[];
                        outgoing_port_range?: number[];
                        status: "active"
                        | "inactive";
                    }
                    | {
                        data_interface?: null
                        | string;
                        DATA_TYPE: "node#1.1.0";
                        id?: string;
                        incoming_port_range?: number[];
                        ip_addresses: string[];
                        outgoing_port_range?: number[];
                        status: "active" | "inactive";
                    }
                    | {
                        data_interface?: null
                        | string;
                        data_interface6?: null | string;
                        DATA_TYPE: "node#1.2.0";
                        id?: string;
                        incoming_port_range?: number[];
                        ip_addresses: string[];
                        outgoing_port_range?: number[];
                        status: "active" | "inactive";
                    }
                )[];
            } & (
                | {
                    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