class ArchiveJobs extends Resource (View source)

The "archiveJobs" collection of methods.

Typical usage is:

 $dataportabilityService = new Google\Service\DataPortability(...);
 $archiveJobs = $dataportabilityService->archiveJobs;

Methods

getPortabilityArchiveState(string $name, array $optParams = [])

Retrieves the state of an Archive job for the Portability API.

retry(string $name, RetryPortabilityArchiveRequest $postBody, array $optParams = [])

Retries a failed Portability Archive job. (archiveJobs.retry)

Details

PortabilityArchiveState getPortabilityArchiveState(string $name, array $optParams = [])

Retrieves the state of an Archive job for the Portability API.

(archiveJobs.getPortabilityArchiveState)

Parameters

string $name

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.

array $optParams

Optional parameters.

Return Value

PortabilityArchiveState

Exceptions

Exception

RetryPortabilityArchiveResponse retry(string $name, RetryPortabilityArchiveRequest $postBody, array $optParams = [])

Retries a failed Portability Archive job. (archiveJobs.retry)

Parameters

string $name

Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed.

RetryPortabilityArchiveRequest $postBody
array $optParams

Optional parameters.

Return Value

RetryPortabilityArchiveResponse

Exceptions

Exception