DataPortability

import { DataPortability } from "https://googleapis.deno.dev/v1/dataportability:v1.ts";

The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.

class DataPortability {

constructor(client?: CredentialsClient, baseUrl?: string);

async archiveJobsGetPortabilityArchiveState(name: string): Promise<PortabilityArchiveState>;

async archiveJobsRetry(name: string, req: RetryPortabilityArchiveRequest): Promise<RetryPortabilityArchiveResponse>;

async authorizationReset(req: ResetAuthorizationRequest): Promise<Empty>;

async portabilityArchiveInitiate(req: InitiatePortabilityArchiveRequest): Promise<InitiatePortabilityArchiveResponse>;

}

§Constructors

new DataPortability(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

archiveJobsGetPortabilityArchiveState(name: string): Promise<PortabilityArchiveState>

[src]

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

@param 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.

archiveJobsRetry(name: string, req: RetryPortabilityArchiveRequest): Promise<RetryPortabilityArchiveResponse>

[src]

Retries a failed Portability Archive job.

@param name

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

authorizationReset(req: ResetAuthorizationRequest): Promise<Empty>

[src]

Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job.

portabilityArchiveInitiate(req: InitiatePortabilityArchiveRequest): Promise<InitiatePortabilityArchiveResponse>

[src]

Initiates a new Archive job for the Portability API.