Debian Codegraph @

docs/dyn/dataportability_v1.archiveJobs.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="dataportability_v1.html">Data Portability API</a> . <a href="dataportability_v1.archiveJobs.html">archiveJobs</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Cancels a Portability Archive job.</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#getPortabilityArchiveState">getPortabilityArchiveState(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves the state of an Archive job for the Portability API.</p>
86 <p class="toc_element">
87 <code><a href="#retry">retry(name, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retries a failed Portability Archive job.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
92 <pre>Cancels a Portability Archive job.
93
94 Args:
95 name: string, Required. The Archive job ID you&#x27;re canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job}. Canceling is only executed if the job is in progress. (required)
96 body: object, The request body.
97 The object takes the form of:
98
99 { # Request to cancel a Portability Archive job.
100 }
101
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # Response to canceling a Data Portability Archive job.
111 }</pre>
112 </div>
113
114 <div class="method">
115 <code class="details" id="close">close()</code>
116 <pre>Close httplib2 connections.</pre>
117 </div>
118
119 <div class="method">
120 <code class="details" id="getPortabilityArchiveState">getPortabilityArchiveState(name, x__xgafv=None)</code>
121 <pre>Retrieves the state of an Archive job for the Portability API.
122
123 Args:
124 name: string, Required. The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse. (required)
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130 Returns:
131 An object of the form:
132
133 { # Resource that contains the state of an Archive job.
134 &quot;exportTime&quot;: &quot;A String&quot;, # The timestamp that represents the end point for the data you are exporting. If the end_time value is set in the InitiatePortabilityArchiveRequest, this field is set to that value. If end_time is not set, this value is set to the time the export was requested.
135 &quot;name&quot;: &quot;A String&quot;, # The resource name of ArchiveJob&#x27;s PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request.
136 &quot;startTime&quot;: &quot;A String&quot;, # The timestamp that represents the starting point for the data you are exporting. This field is set only if the start_time field is specified in the InitiatePortabilityArchiveRequest.
137 &quot;state&quot;: &quot;A String&quot;, # Resource that represents the state of the Archive job.
138 &quot;urls&quot;: [ # If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket.
139 &quot;A String&quot;,
140 ],
141 }</pre>
142 </div>
143
144 <div class="method">
145 <code class="details" id="retry">retry(name, body=None, x__xgafv=None)</code>
146 <pre>Retries a failed Portability Archive job.
147
148 Args:
149 name: string, Required. The Archive job ID you&#x27;re retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed. (required)
150 body: object, The request body.
151 The object takes the form of:
152
153 { # Request to retry a failed Portability Archive job.
154 }
155
156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
160
161 Returns:
162 An object of the form:
163
164 { # Response from retrying a Portability Archive.
165 &quot;archiveJobId&quot;: &quot;A String&quot;, # The archive job ID that is initiated by the retry endpoint. This can be used to get the state of the new job.
166 }</pre>
167 </div>
168
169 </body></html>