Debian Codegraph @

docs/dyn/admin_datatransfer_v1.applications.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="admin_datatransfer_v1.html">Admin SDK API</a> . <a href="admin_datatransfer_v1.applications.html">applications</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(applicationId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves information about an application for the given application ID.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(customerId=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Lists the applications available for data transfer for a customer.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(applicationId, x__xgafv=None)</code>
97 <pre>Retrieves information about an application for the given application ID.
98
99 Args:
100 applicationId: string, ID of the application resource to be retrieved. (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106 Returns:
107 An object of the form:
108
109 { # Application resources represent applications installed on the domain that support transferring ownership of user data.
110 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
111 &quot;id&quot;: &quot;A String&quot;, # The application&#x27;s ID. Retrievable by using the [`applications.list()`](https://developers.google.com/workspace/admin/data-transfer/reference/rest/v1/applications/list) method.
112 &quot;kind&quot;: &quot;admin#datatransfer#ApplicationResource&quot;, # Identifies the resource as a DataTransfer Application Resource.
113 &quot;name&quot;: &quot;A String&quot;, # The application&#x27;s name.
114 &quot;transferParams&quot;: [ # The list of all possible transfer parameters for this application. These parameters select which categories of the user&#x27;s data to transfer.
115 { # Template for application transfer parameters.
116 &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
117 &quot;value&quot;: [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
118 &quot;A String&quot;,
119 ],
120 },
121 ],
122 }</pre>
123 </div>
124
125 <div class="method">
126 <code class="details" id="list">list(customerId=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
127 <pre>Lists the applications available for data transfer for a customer.
128
129 Args:
130 customerId: string, Immutable ID of the Google Workspace account.
131 maxResults: integer, Maximum number of results to return. Default is 100.
132 pageToken: string, Token to specify next page in the list.
133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
137
138 Returns:
139 An object of the form:
140
141 { # Template for a collection of Applications.
142 &quot;applications&quot;: [ # The list of applications that support data transfer and are also installed for the customer.
143 { # Application resources represent applications installed on the domain that support transferring ownership of user data.
144 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
145 &quot;id&quot;: &quot;A String&quot;, # The application&#x27;s ID. Retrievable by using the [`applications.list()`](https://developers.google.com/workspace/admin/data-transfer/reference/rest/v1/applications/list) method.
146 &quot;kind&quot;: &quot;admin#datatransfer#ApplicationResource&quot;, # Identifies the resource as a DataTransfer Application Resource.
147 &quot;name&quot;: &quot;A String&quot;, # The application&#x27;s name.
148 &quot;transferParams&quot;: [ # The list of all possible transfer parameters for this application. These parameters select which categories of the user&#x27;s data to transfer.
149 { # Template for application transfer parameters.
150 &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
151 &quot;value&quot;: [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
152 &quot;A String&quot;,
153 ],
154 },
155 ],
156 },
157 ],
158 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
159 &quot;kind&quot;: &quot;admin#datatransfer#applicationsList&quot;, # Identifies the resource as a collection of Applications.
160 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to specify the next page in the list.
161 }</pre>
162 </div>
163
164 <div class="method">
165 <code class="details" id="list_next">list_next()</code>
166 <pre>Retrieves the next page of results.
167
168 Args:
169 previous_request: The request for the previous page. (required)
170 previous_response: The response from the request for the previous page. (required)
171
172 Returns:
173 A request object that you can call &#x27;execute()&#x27; on to request the next
174 page. Returns None if there are no more items in the collection.
175 </pre>
176 </div>
177
178 </body></html>