1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
Globus Connect Server API
=========================
.. currentmodule:: globus_sdk
The Globus Connect Server Manager API (GCS Manager API) runs on a
Globus Connect Server Endpoint and allows management of the Endpoint,
Storage Gateways, Collections, and other resources.
Unlike other Globus services, there is no single central API used to contact
GCS Manager instances. Therefore, the :class:`GCSClient` is always initialized with
the FQDN (DNS name) of the GCS Endpoint.
e.g. ``gcs = GCSClient("abc.def.data.globus.org")``
Client
------
The primary interface for the GCS Manager API is the :class:`GCSClient` class.
.. autoclass:: GCSClient
:members:
:member-order: bysource
:show-inheritance:
:exclude-members: error_class
Helper Objects
--------------
.. autoclass:: EndpointDocument
:members:
:show-inheritance:
.. autoclass:: GCSRoleDocument
:members:
:show-inheritance:
.. autoclass:: StorageGatewayDocument
:members:
:show-inheritance:
.. autoclass:: UserCredentialDocument
:members:
:show-inheritance:
Collections
~~~~~~~~~~~
.. autoclass:: CollectionDocument
:members:
:show-inheritance:
.. autoclass:: MappedCollectionDocument
:members:
:show-inheritance:
.. autoclass:: GuestCollectionDocument
:members:
:show-inheritance:
Storage Gateway Policies
~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: StorageGatewayPolicies
:members:
:show-inheritance:
.. autoclass:: ActiveScaleStoragePolicies
:members:
:show-inheritance:
.. autoclass:: AzureBlobStoragePolicies
:members:
:show-inheritance:
.. autoclass:: BlackPearlStoragePolicies
:members:
:show-inheritance:
.. autoclass:: BoxStoragePolicies
:members:
:show-inheritance:
.. autoclass:: CephStoragePolicies
:members:
:show-inheritance:
.. autoclass:: CollectionPolicies
:members:
:show-inheritance:
.. autoclass:: GoogleCloudStorageCollectionPolicies
:members:
:show-inheritance:
.. autoclass:: GoogleCloudStoragePolicies
:members:
:show-inheritance:
.. autoclass:: GoogleDriveStoragePolicies
:members:
:show-inheritance:
.. autoclass:: HPSSStoragePolicies
:members:
:show-inheritance:
.. autoclass:: IrodsStoragePolicies
:members:
:show-inheritance:
.. autoclass:: OneDriveStoragePolicies
:members:
:show-inheritance:
.. autoclass:: POSIXCollectionPolicies
:members:
:show-inheritance:
.. autoclass:: POSIXStagingCollectionPolicies
:members:
:show-inheritance:
.. autoclass:: POSIXStagingStoragePolicies
:members:
:show-inheritance:
.. autoclass:: POSIXStoragePolicies
:members:
:show-inheritance:
.. autoclass:: S3StoragePolicies
:members:
:show-inheritance:
.. autoclass:: ConnectorTable
:members:
:show-inheritance:
.. autoclass:: GlobusConnectServerConnector
:members:
:show-inheritance:
Client Errors
-------------
When an error occurs, a :class:`GCSClient` will raise this specialized type of
error, rather than a generic :class:`GlobusAPIError`.
.. autoclass:: GCSAPIError
:members:
:show-inheritance:
GCS Responses
-------------
.. autoclass:: IterableGCSResponse
:members:
:show-inheritance:
.. autoclass:: UnpackingGCSResponse
:members:
:show-inheritance:
|
