@maxim_mazurok/gapi.client.dataportability-v1 0.0.20250211 → 0.0.20250212
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +71 -1
- package/package.json +1 -1
- package/readme.md +5 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://dataportability.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250212
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -28,18 +28,30 @@ declare namespace gapi.client {
|
|
|
28
28
|
): void;
|
|
29
29
|
|
|
30
30
|
namespace dataportability {
|
|
31
|
+
interface CancelPortabilityArchiveRequest {}
|
|
32
|
+
interface CancelPortabilityArchiveResponse {}
|
|
31
33
|
interface Empty {}
|
|
32
34
|
interface InitiatePortabilityArchiveRequest {
|
|
35
|
+
/** Optional. The timestamp that represents the end point for the data you are exporting. If the end_time is not specified in the InitiatePortabilityArchiveRequest, this field is set to the latest available data. */
|
|
36
|
+
endTime?: string;
|
|
33
37
|
/** The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes. */
|
|
34
38
|
resources?: string[];
|
|
39
|
+
/** Optional. The timestamp that represents the starting point for the data you are exporting. If the start_time is not specified in the InitiatePortabilityArchiveRequest, the field is set to the earliest available data. */
|
|
40
|
+
startTime?: string;
|
|
35
41
|
}
|
|
36
42
|
interface InitiatePortabilityArchiveResponse {
|
|
43
|
+
/** The access type of the Archive job initiated by the API. */
|
|
44
|
+
accessType?: string;
|
|
37
45
|
/** The archive job ID that is initiated in the API. This can be used to get the state of the job. */
|
|
38
46
|
archiveJobId?: string;
|
|
39
47
|
}
|
|
40
48
|
interface PortabilityArchiveState {
|
|
49
|
+
/** 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. */
|
|
50
|
+
exportTime?: string;
|
|
41
51
|
/** 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. */
|
|
42
52
|
name?: string;
|
|
53
|
+
/** 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. */
|
|
54
|
+
startTime?: string;
|
|
43
55
|
/** Resource that represents the state of the Archive job. */
|
|
44
56
|
state?: string;
|
|
45
57
|
/** If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket. */
|
|
@@ -52,6 +64,64 @@ declare namespace gapi.client {
|
|
|
52
64
|
archiveJobId?: string;
|
|
53
65
|
}
|
|
54
66
|
interface ArchiveJobsResource {
|
|
67
|
+
/** Cancels a Portability Archive job. */
|
|
68
|
+
cancel(request: {
|
|
69
|
+
/** V1 error format. */
|
|
70
|
+
'$.xgafv'?: string;
|
|
71
|
+
/** OAuth access token. */
|
|
72
|
+
access_token?: string;
|
|
73
|
+
/** Data format for response. */
|
|
74
|
+
alt?: string;
|
|
75
|
+
/** JSONP */
|
|
76
|
+
callback?: string;
|
|
77
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
78
|
+
fields?: string;
|
|
79
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
80
|
+
key?: string;
|
|
81
|
+
/** 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. */
|
|
82
|
+
name: string;
|
|
83
|
+
/** OAuth 2.0 token for the current user. */
|
|
84
|
+
oauth_token?: string;
|
|
85
|
+
/** Returns response with indentations and line breaks. */
|
|
86
|
+
prettyPrint?: boolean;
|
|
87
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
88
|
+
quotaUser?: string;
|
|
89
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
90
|
+
upload_protocol?: string;
|
|
91
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
92
|
+
uploadType?: string;
|
|
93
|
+
/** Request body */
|
|
94
|
+
resource: CancelPortabilityArchiveRequest;
|
|
95
|
+
}): Request<{}>;
|
|
96
|
+
cancel(
|
|
97
|
+
request: {
|
|
98
|
+
/** V1 error format. */
|
|
99
|
+
'$.xgafv'?: string;
|
|
100
|
+
/** OAuth access token. */
|
|
101
|
+
access_token?: string;
|
|
102
|
+
/** Data format for response. */
|
|
103
|
+
alt?: string;
|
|
104
|
+
/** JSONP */
|
|
105
|
+
callback?: string;
|
|
106
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
107
|
+
fields?: string;
|
|
108
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
109
|
+
key?: string;
|
|
110
|
+
/** 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. */
|
|
111
|
+
name: string;
|
|
112
|
+
/** OAuth 2.0 token for the current user. */
|
|
113
|
+
oauth_token?: string;
|
|
114
|
+
/** Returns response with indentations and line breaks. */
|
|
115
|
+
prettyPrint?: boolean;
|
|
116
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
117
|
+
quotaUser?: string;
|
|
118
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
119
|
+
upload_protocol?: string;
|
|
120
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
121
|
+
uploadType?: string;
|
|
122
|
+
},
|
|
123
|
+
body: CancelPortabilityArchiveRequest,
|
|
124
|
+
): Request<{}>;
|
|
55
125
|
/** Retrieves the state of an Archive job for the Portability API. */
|
|
56
126
|
getPortabilityArchiveState(request?: {
|
|
57
127
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -264,6 +264,11 @@ gapi.auth.authorize(
|
|
|
264
264
|
After that you can use Data Portability API resources: <!-- TODO: make this work for multiple namespaces -->
|
|
265
265
|
|
|
266
266
|
```typescript
|
|
267
|
+
/*
|
|
268
|
+
Cancels a Portability Archive job.
|
|
269
|
+
*/
|
|
270
|
+
await gapi.client.dataportability.archiveJobs.cancel({name: 'name'});
|
|
271
|
+
|
|
267
272
|
/*
|
|
268
273
|
Retrieves the state of an Archive job for the Portability API.
|
|
269
274
|
*/
|