- patch(configuration, options?, sdkOptions?): Promise<JSONFetchResponse<{
code?: "success";
data?: ({
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.0.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
} | {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.1.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null | number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
} | {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.2.0";
department?: string;
description?: string;
display_name: string;
earliest_last_access?: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null | number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
})[];
} & ({
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
Optional
options: {
payload:
| Record<string, unknown>
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.0.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.1.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null | number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.2.0";
department?: string;
description?: string;
display_name: string;
earliest_last_access?: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null | number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
};
} & {
headers?: Headers;
query?: {
[key: string]:
| string
| number
| boolean
| (
| string
| number
| null
| undefined)[]
| null
| undefined;
};
}Optional
sdkOptions: SDKOptions
Returns Promise<JSONFetchResponse<{
code?: "success";
data?: ({
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.0.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
} | {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.1.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null | number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
} | {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.2.0";
department?: string;
description?: string;
display_name: string;
earliest_last_access?: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null | number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use?:
| "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public?: boolean;
subscription_id?: null | string;
})[];
} & ({
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;
})>>
See
https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Endpoint/#patchEndpoint