Data Portability API . archiveJobs

cancel(name, body=None, x__xgafv=None)

Cancels a Portability Archive job.

Args:
  name: string, Required. The Archive job ID you'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.
}

close()

Close httplib2 connections.

getPortabilityArchiveState(name, x__xgafv=None)

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.
  "exportTime": "A String", # 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.
  "name": "A String", # The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request.
  "startTime": "A String", # 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.
  "state": "A String", # Resource that represents the state of the Archive job.
  "urls": [ # If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket.
    "A String",
  ],
}

retry(name, body=None, x__xgafv=None)

Retries a failed Portability Archive job.

Args:
  name: string, Required. The Archive job ID you'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.
  "archiveJobId": "A String", # The archive job ID that is initiated by the retry endpoint. This can be used to get the state of the new job.
}