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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_datatransfer_v1.html">Admin SDK API</a> . <a href="admin_datatransfer_v1.transfers.html">transfers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(dataTransferId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a data transfer request by its resource ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a data transfer request. See the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference for specific application requirements.</p>
<p class="toc_element">
<code><a href="#list">list(customerId=None, maxResults=None, newOwnerUserId=None, oldOwnerUserId=None, pageToken=None, status=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the transfers for a customer by source user, destination user, or status.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(dataTransferId, x__xgafv=None)</code>
<pre>Retrieves a data transfer request by its resource ID.
Args:
dataTransferId: string, ID of the resource to be retrieved. This is returned in the response from the insert method. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Transfer resource represents the transfer of the ownership of user data between users.
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
{ # Template to map fields of ApplicationDataTransfer resource.
"applicationId": "A String", # The application's ID.
"applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference.
{ # Template for application transfer parameters.
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
"A String",
],
},
],
"applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
},
],
"etag": "A String", # ETag of the resource.
"id": "A String", # Read-only. The transfer's ID.
"kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
"newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
"oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
"overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
"requestTime": "A String", # Read-only. The time at which the data transfer was requested.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
<pre>Inserts a data transfer request. See the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference for specific application requirements.
Args:
body: object, The request body.
The object takes the form of:
{ # A Transfer resource represents the transfer of the ownership of user data between users.
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
{ # Template to map fields of ApplicationDataTransfer resource.
"applicationId": "A String", # The application's ID.
"applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference.
{ # Template for application transfer parameters.
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
"A String",
],
},
],
"applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
},
],
"etag": "A String", # ETag of the resource.
"id": "A String", # Read-only. The transfer's ID.
"kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
"newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
"oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
"overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
"requestTime": "A String", # Read-only. The time at which the data transfer was requested.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Transfer resource represents the transfer of the ownership of user data between users.
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
{ # Template to map fields of ApplicationDataTransfer resource.
"applicationId": "A String", # The application's ID.
"applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference.
{ # Template for application transfer parameters.
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
"A String",
],
},
],
"applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
},
],
"etag": "A String", # ETag of the resource.
"id": "A String", # Read-only. The transfer's ID.
"kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
"newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
"oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
"overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
"requestTime": "A String", # Read-only. The time at which the data transfer was requested.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId=None, maxResults=None, newOwnerUserId=None, oldOwnerUserId=None, pageToken=None, status=None, x__xgafv=None)</code>
<pre>Lists the transfers for a customer by source user, destination user, or status.
Args:
customerId: string, Immutable ID of the Google Workspace account.
maxResults: integer, Maximum number of results to return. Default is 100.
newOwnerUserId: string, Destination user's profile ID.
oldOwnerUserId: string, Source user's profile ID.
pageToken: string, Token to specify the next page in the list.
status: string, Status of the transfer.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Template for a collection of DataTransfer resources.
"dataTransfers": [ # List of data transfer requests.
{ # A Transfer resource represents the transfer of the ownership of user data between users.
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
{ # Template to map fields of ApplicationDataTransfer resource.
"applicationId": "A String", # The application's ID.
"applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference.
{ # Template for application transfer parameters.
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
"A String",
],
},
],
"applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
},
],
"etag": "A String", # ETag of the resource.
"id": "A String", # Read-only. The transfer's ID.
"kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
"newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
"oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
"overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
"requestTime": "A String", # Read-only. The time at which the data transfer was requested.
},
],
"etag": "A String", # ETag of the resource.
"kind": "admin#datatransfer#dataTransfersList", # Identifies the resource as a collection of data transfer requests.
"nextPageToken": "A String", # Token to specify the next page in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
