docs/dyn/dataportability_v1.archiveJobs.html

<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="dataportability_v1.html">Data Portability API</a> . <a href="dataportability_v1.archiveJobs.html">archiveJobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels a Portability Archive job.</p>
<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="#getPortabilityArchiveState">getPortabilityArchiveState(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the state of an Archive job for the Portability API.</p>
<p class="toc_element">
  <code><a href="#retry">retry(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retries a failed Portability Archive job.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
  <pre>Cancels a Portability Archive job.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # Request to cancel a Portability Archive job.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to canceling a Data Portability Archive job.
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="getPortabilityArchiveState">getPortabilityArchiveState(name, x__xgafv=None)</code>
  <pre>Retrieves the state of an Archive job for the Portability API.

Args:
  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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Resource that contains the state of an Archive job.
  &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.
  &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.
  &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.
  &quot;state&quot;: &quot;A String&quot;, # Resource that represents the state of the Archive job.
  &quot;urls&quot;: [ # If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="retry">retry(name, body=None, x__xgafv=None)</code>
  <pre>Retries a failed Portability Archive job.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # Request to retry a failed Portability Archive job.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response from retrying a Portability Archive.
  &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.
}</pre>
</div>

</body></html>