@maxim_mazurok/gapi.client.storagetransfer-v1 0.0.20220808
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 +1311 -0
- package/package.json +20 -0
- package/readme.md +123 -0
- package/tests.ts +420 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,1311 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Storage Transfer API v1 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/storage-transfer/docs
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://storagetransfer.googleapis.com/$discovery/rest?version=v1
|
|
13
|
+
// Revision: 20220808
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load Storage Transfer API v1 */
|
|
19
|
+
function load(urlOrObject: "https://storagetransfer.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "storagetransfer", version: "v1"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "storagetransfer", version: "v1", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace storagetransfer {
|
|
26
|
+
interface AgentPool {
|
|
27
|
+
/** Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. */
|
|
28
|
+
bandwidthLimit?: BandwidthLimit;
|
|
29
|
+
/** Specifies the client-specified AgentPool description. */
|
|
30
|
+
displayName?: string;
|
|
31
|
+
/** Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` */
|
|
32
|
+
name?: string;
|
|
33
|
+
/** Output only. Specifies the state of the AgentPool. */
|
|
34
|
+
state?: string;
|
|
35
|
+
}
|
|
36
|
+
interface AwsAccessKey {
|
|
37
|
+
/** Required. AWS access key ID. */
|
|
38
|
+
accessKeyId?: string;
|
|
39
|
+
/** Required. AWS secret access key. This field is not returned in RPC responses. */
|
|
40
|
+
secretAccessKey?: string;
|
|
41
|
+
}
|
|
42
|
+
interface AwsS3CompatibleData {
|
|
43
|
+
/** Required. Specifies the name of the bucket. */
|
|
44
|
+
bucketName?: string;
|
|
45
|
+
/** Required. Specifies the endpoint of the storage service. */
|
|
46
|
+
endpoint?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Specifies the root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally
|
|
49
|
+
* not begin with a '/'.
|
|
50
|
+
*/
|
|
51
|
+
path?: string;
|
|
52
|
+
/** Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region. */
|
|
53
|
+
region?: string;
|
|
54
|
+
/** A S3 compatible metadata. */
|
|
55
|
+
s3Metadata?: S3CompatibleMetadata;
|
|
56
|
+
}
|
|
57
|
+
interface AwsS3Data {
|
|
58
|
+
/**
|
|
59
|
+
* Input only. AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. For information on
|
|
60
|
+
* our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials).
|
|
61
|
+
*/
|
|
62
|
+
awsAccessKey?: AwsAccessKey;
|
|
63
|
+
/** Required. S3 Bucket name (see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). */
|
|
64
|
+
bucketName?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with
|
|
67
|
+
* a '/'.
|
|
68
|
+
*/
|
|
69
|
+
path?: string;
|
|
70
|
+
/**
|
|
71
|
+
* The Amazon Resource Name (ARN) of the role to support temporary credentials via `AssumeRoleWithWebIdentity`. For more information about ARNs, see [IAM
|
|
72
|
+
* ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). When a role ARN is provided, Transfer Service fetches temporary credentials for
|
|
73
|
+
* the session using a `AssumeRoleWithWebIdentity` call for the provided role using the GoogleServiceAccount for this project.
|
|
74
|
+
*/
|
|
75
|
+
roleArn?: string;
|
|
76
|
+
}
|
|
77
|
+
interface AzureBlobStorageData {
|
|
78
|
+
/**
|
|
79
|
+
* Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User
|
|
80
|
+
* credentials](/storage-transfer/docs/data-retention#user-credentials).
|
|
81
|
+
*/
|
|
82
|
+
azureCredentials?: AzureCredentials;
|
|
83
|
+
/** Required. The container to transfer from the Azure Storage account. */
|
|
84
|
+
container?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with
|
|
87
|
+
* a '/'.
|
|
88
|
+
*/
|
|
89
|
+
path?: string;
|
|
90
|
+
/** Required. The name of the Azure Storage account. */
|
|
91
|
+
storageAccount?: string;
|
|
92
|
+
}
|
|
93
|
+
interface AzureCredentials {
|
|
94
|
+
/**
|
|
95
|
+
* Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures
|
|
96
|
+
* (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview).
|
|
97
|
+
*/
|
|
98
|
+
sasToken?: string;
|
|
99
|
+
}
|
|
100
|
+
interface BandwidthLimit {
|
|
101
|
+
/** Bandwidth rate in megabytes per second, distributed across all the agents in the pool. */
|
|
102
|
+
limitMbps?: string;
|
|
103
|
+
}
|
|
104
|
+
// tslint:disable-next-line:no-empty-interface
|
|
105
|
+
interface CancelOperationRequest {
|
|
106
|
+
}
|
|
107
|
+
interface Date {
|
|
108
|
+
/** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
|
|
109
|
+
day?: number;
|
|
110
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
111
|
+
month?: number;
|
|
112
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
113
|
+
year?: number;
|
|
114
|
+
}
|
|
115
|
+
// tslint:disable-next-line:no-empty-interface
|
|
116
|
+
interface Empty {
|
|
117
|
+
}
|
|
118
|
+
interface ErrorLogEntry {
|
|
119
|
+
/** A list of messages that carry the error details. */
|
|
120
|
+
errorDetails?: string[];
|
|
121
|
+
/** Required. A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. */
|
|
122
|
+
url?: string;
|
|
123
|
+
}
|
|
124
|
+
interface ErrorSummary {
|
|
125
|
+
/** Required. */
|
|
126
|
+
errorCode?: string;
|
|
127
|
+
/** Required. Count of this type of error. */
|
|
128
|
+
errorCount?: string;
|
|
129
|
+
/** Error samples. At most 5 error log entries are recorded for a given error code for a single transfer operation. */
|
|
130
|
+
errorLogEntries?: ErrorLogEntry[];
|
|
131
|
+
}
|
|
132
|
+
interface GcsData {
|
|
133
|
+
/** Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). */
|
|
134
|
+
bucketName?: string;
|
|
135
|
+
/**
|
|
136
|
+
* Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with
|
|
137
|
+
* a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames).
|
|
138
|
+
*/
|
|
139
|
+
path?: string;
|
|
140
|
+
}
|
|
141
|
+
interface GoogleServiceAccount {
|
|
142
|
+
/** Email address of the service account. */
|
|
143
|
+
accountEmail?: string;
|
|
144
|
+
/** Unique identifier for the service account. */
|
|
145
|
+
subjectId?: string;
|
|
146
|
+
}
|
|
147
|
+
interface HttpData {
|
|
148
|
+
/** Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. */
|
|
149
|
+
listUrl?: string;
|
|
150
|
+
}
|
|
151
|
+
interface ListAgentPoolsResponse {
|
|
152
|
+
/** A list of agent pools. */
|
|
153
|
+
agentPools?: AgentPool[];
|
|
154
|
+
/** The list next page token. */
|
|
155
|
+
nextPageToken?: string;
|
|
156
|
+
}
|
|
157
|
+
interface ListOperationsResponse {
|
|
158
|
+
/** The standard List next-page token. */
|
|
159
|
+
nextPageToken?: string;
|
|
160
|
+
/** A list of operations that matches the specified filter in the request. */
|
|
161
|
+
operations?: Operation[];
|
|
162
|
+
}
|
|
163
|
+
interface ListTransferJobsResponse {
|
|
164
|
+
/** The list next page token. */
|
|
165
|
+
nextPageToken?: string;
|
|
166
|
+
/** A list of transfer jobs. */
|
|
167
|
+
transferJobs?: TransferJob[];
|
|
168
|
+
}
|
|
169
|
+
interface LoggingConfig {
|
|
170
|
+
/** For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer. */
|
|
171
|
+
enableOnpremGcsTransferLogs?: boolean;
|
|
172
|
+
/** Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. */
|
|
173
|
+
logActions?: string[];
|
|
174
|
+
/**
|
|
175
|
+
* States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs
|
|
176
|
+
* instead.
|
|
177
|
+
*/
|
|
178
|
+
logActionStates?: string[];
|
|
179
|
+
}
|
|
180
|
+
interface MetadataOptions {
|
|
181
|
+
/**
|
|
182
|
+
* Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as
|
|
183
|
+
* ACL_DESTINATION_BUCKET_DEFAULT.
|
|
184
|
+
*/
|
|
185
|
+
acl?: string;
|
|
186
|
+
/**
|
|
187
|
+
* Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer. By default, GID is not preserved. Only applicable to transfers involving POSIX file
|
|
188
|
+
* systems, and ignored for other transfers.
|
|
189
|
+
*/
|
|
190
|
+
gid?: string;
|
|
191
|
+
/**
|
|
192
|
+
* Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is
|
|
193
|
+
* the same as KMS_KEY_DESTINATION_BUCKET_DEFAULT.
|
|
194
|
+
*/
|
|
195
|
+
kmsKey?: string;
|
|
196
|
+
/**
|
|
197
|
+
* Specifies how each file's mode attribute should be handled by the transfer. By default, mode is not preserved. Only applicable to transfers involving POSIX file systems, and ignored
|
|
198
|
+
* for other transfers.
|
|
199
|
+
*/
|
|
200
|
+
mode?: string;
|
|
201
|
+
/**
|
|
202
|
+
* Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets. If unspecified, the default behavior is the same as
|
|
203
|
+
* STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT.
|
|
204
|
+
*/
|
|
205
|
+
storageClass?: string;
|
|
206
|
+
/**
|
|
207
|
+
* Specifies how symlinks should be handled by the transfer. By default, symlinks are not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other
|
|
208
|
+
* transfers.
|
|
209
|
+
*/
|
|
210
|
+
symlink?: string;
|
|
211
|
+
/**
|
|
212
|
+
* Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as
|
|
213
|
+
* TEMPORARY_HOLD_PRESERVE.
|
|
214
|
+
*/
|
|
215
|
+
temporaryHold?: string;
|
|
216
|
+
/**
|
|
217
|
+
* Specifies how each object's `timeCreated` metadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as
|
|
218
|
+
* TIME_CREATED_SKIP.
|
|
219
|
+
*/
|
|
220
|
+
timeCreated?: string;
|
|
221
|
+
/**
|
|
222
|
+
* Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer. By default, UID is not preserved. Only applicable to transfers involving POSIX file
|
|
223
|
+
* systems, and ignored for other transfers.
|
|
224
|
+
*/
|
|
225
|
+
uid?: string;
|
|
226
|
+
}
|
|
227
|
+
interface NotificationConfig {
|
|
228
|
+
/** Event types for which a notification is desired. If empty, send notifications for all event types. */
|
|
229
|
+
eventTypes?: string[];
|
|
230
|
+
/** Required. The desired format of the notification message payloads. */
|
|
231
|
+
payloadFormat?: string;
|
|
232
|
+
/**
|
|
233
|
+
* Required. The `Topic.name` of the Pub/Sub topic to which to publish notifications. Must be of the format: `projects/{project}/topics/{topic}`. Not matching this format results in an
|
|
234
|
+
* INVALID_ARGUMENT error.
|
|
235
|
+
*/
|
|
236
|
+
pubsubTopic?: string;
|
|
237
|
+
}
|
|
238
|
+
interface ObjectConditions {
|
|
239
|
+
/**
|
|
240
|
+
* If you specify `exclude_prefixes`, Storage Transfer Service uses the items in the `exclude_prefixes` array to determine which objects to exclude from a transfer. Objects must not
|
|
241
|
+
* start with one of the matching `exclude_prefixes` for inclusion in a transfer. The following are requirements of `exclude_prefixes`: * Each exclude-prefix can contain any sequence
|
|
242
|
+
* of Unicode characters, to a max length of 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression
|
|
243
|
+
* matching are not supported. * Each exclude-prefix must omit the leading slash. For example, to exclude the object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the
|
|
244
|
+
* exclude-prefix as `logs/y=2015/requests.gz`. * None of the exclude-prefix values can be empty, if specified. * Each exclude-prefix must exclude a distinct portion of the object
|
|
245
|
+
* namespace. No exclude-prefix may be a prefix of another exclude-prefix. * If include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly
|
|
246
|
+
* included by `include_prefixes`. The max size of `exclude_prefixes` is 1000. For more information, see [Filtering objects from
|
|
247
|
+
* transfers](/storage-transfer/docs/filtering-objects-from-transfers).
|
|
248
|
+
*/
|
|
249
|
+
excludePrefixes?: string[];
|
|
250
|
+
/**
|
|
251
|
+
* If you specify `include_prefixes`, Storage Transfer Service uses the items in the `include_prefixes` array to determine which objects to include in a transfer. Objects must start
|
|
252
|
+
* with one of the matching `include_prefixes` for inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of the `exclude_prefixes` specified for
|
|
253
|
+
* inclusion in the transfer. The following are requirements of `include_prefixes`: * Each include-prefix can contain any sequence of Unicode characters, to a max length of 1024 bytes
|
|
254
|
+
* when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix must omit
|
|
255
|
+
* the leading slash. For example, to include the object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include-prefix as `logs/y=2015/requests.gz`. * None of the
|
|
256
|
+
* include-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace. No include-prefix may be a prefix of another
|
|
257
|
+
* include-prefix. The max size of `include_prefixes` is 1000. For more information, see [Filtering objects from transfers](/storage-transfer/docs/filtering-objects-from-transfers).
|
|
258
|
+
*/
|
|
259
|
+
includePrefixes?: string[];
|
|
260
|
+
/** If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred. */
|
|
261
|
+
lastModifiedBefore?: string;
|
|
262
|
+
/**
|
|
263
|
+
* If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred. The
|
|
264
|
+
* `last_modified_since` and `last_modified_before` fields can be used together for chunked data processing. For example, consider a script that processes each day's worth of data at a
|
|
265
|
+
* time. For that you'd set each of the fields as follows: * `last_modified_since` to the start of the day * `last_modified_before` to the end of the day
|
|
266
|
+
*/
|
|
267
|
+
lastModifiedSince?: string;
|
|
268
|
+
/**
|
|
269
|
+
* Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last
|
|
270
|
+
* modification time" are transferred only if the elapsed time between the start_time of the `TransferOperation`and the "last modification time" of the object is less than the value of
|
|
271
|
+
* max_time_elapsed_since_last_modification`. Objects that do not have a "last modification time" are also transferred.
|
|
272
|
+
*/
|
|
273
|
+
maxTimeElapsedSinceLastModification?: string;
|
|
274
|
+
/**
|
|
275
|
+
* Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last
|
|
276
|
+
* modification time" are transferred only if the elapsed time between the start_time of the `TransferOperation` and the "last modification time" of the object is equal to or greater
|
|
277
|
+
* than the value of min_time_elapsed_since_last_modification`. Objects that do not have a "last modification time" are also transferred.
|
|
278
|
+
*/
|
|
279
|
+
minTimeElapsedSinceLastModification?: string;
|
|
280
|
+
}
|
|
281
|
+
interface Operation {
|
|
282
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
283
|
+
done?: boolean;
|
|
284
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
285
|
+
error?: Status;
|
|
286
|
+
/** Represents the transfer operation object. To request a TransferOperation object, use transferOperations.get. */
|
|
287
|
+
metadata?: { [P in string]: any };
|
|
288
|
+
/** The server-assigned unique name. The format of `name` is `transferOperations/some/unique/name`. */
|
|
289
|
+
name?: string;
|
|
290
|
+
/**
|
|
291
|
+
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
292
|
+
* original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
|
|
293
|
+
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
294
|
+
*/
|
|
295
|
+
response?: { [P in string]: any };
|
|
296
|
+
}
|
|
297
|
+
// tslint:disable-next-line:no-empty-interface
|
|
298
|
+
interface PauseTransferOperationRequest {
|
|
299
|
+
}
|
|
300
|
+
interface PosixFilesystem {
|
|
301
|
+
/** Root directory path to the filesystem. */
|
|
302
|
+
rootDirectory?: string;
|
|
303
|
+
}
|
|
304
|
+
// tslint:disable-next-line:no-empty-interface
|
|
305
|
+
interface ResumeTransferOperationRequest {
|
|
306
|
+
}
|
|
307
|
+
interface RunTransferJobRequest {
|
|
308
|
+
/** Required. The ID of the Google Cloud project that owns the transfer job. */
|
|
309
|
+
projectId?: string;
|
|
310
|
+
}
|
|
311
|
+
interface S3CompatibleMetadata {
|
|
312
|
+
/** Specifies the authentication and authorization method used by the storage service. When not specified, Transfer Service will attempt to determine right auth method to use. */
|
|
313
|
+
authMethod?: string;
|
|
314
|
+
/** The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use. */
|
|
315
|
+
listApi?: string;
|
|
316
|
+
/** Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used. */
|
|
317
|
+
protocol?: string;
|
|
318
|
+
/** Specifies the API request model used to call the storage service. When not specified, the default value of RequestModel REQUEST_MODEL_VIRTUAL_HOSTED_STYLE is used. */
|
|
319
|
+
requestModel?: string;
|
|
320
|
+
}
|
|
321
|
+
interface Schedule {
|
|
322
|
+
/**
|
|
323
|
+
* The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, `end_time_of_day` specifies the end date and time for starting new transfer
|
|
324
|
+
* operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the
|
|
325
|
+
* following: * If `end_time_of_day` is not set and `schedule_end_date` is set, then a default value of `23:59:59` is used for `end_time_of_day`. * If `end_time_of_day` is set and
|
|
326
|
+
* `schedule_end_date` is not set, then INVALID_ARGUMENT is returned.
|
|
327
|
+
*/
|
|
328
|
+
endTimeOfDay?: TimeOfDay;
|
|
329
|
+
/** Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour. */
|
|
330
|
+
repeatInterval?: string;
|
|
331
|
+
/**
|
|
332
|
+
* The last day a transfer runs. Date boundaries are determined relative to UTC time. A job runs once per 24 hours within the following guidelines: * If `schedule_end_date` and
|
|
333
|
+
* schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * If `schedule_end_date` is later than `schedule_start_date` and
|
|
334
|
+
* `schedule_end_date` is in the future relative to UTC, the job runs each day at start_time_of_day through `schedule_end_date`.
|
|
335
|
+
*/
|
|
336
|
+
scheduleEndDate?: Date;
|
|
337
|
+
/**
|
|
338
|
+
* Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If `schedule_start_date` and start_time_of_day are in the past relative to the job's
|
|
339
|
+
* creation time, the transfer starts the day after you schedule the transfer request. **Note:** When starting jobs at or near midnight UTC it is possible that a job starts later than
|
|
340
|
+
* expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then
|
|
341
|
+
* it creates a TransferJob with `schedule_start_date` set to June 2 and a `start_time_of_day` set to midnight UTC. The first scheduled TransferOperation takes place on June 3 at
|
|
342
|
+
* midnight UTC.
|
|
343
|
+
*/
|
|
344
|
+
scheduleStartDate?: Date;
|
|
345
|
+
/**
|
|
346
|
+
* The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If `start_time_of_day` is not specified: * One-time transfers run immediately. *
|
|
347
|
+
* Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. If `start_time_of_day` is specified: * One-time transfers run at the specified time. *
|
|
348
|
+
* Recurring transfers run at the specified time each day, through `schedule_end_date`.
|
|
349
|
+
*/
|
|
350
|
+
startTimeOfDay?: TimeOfDay;
|
|
351
|
+
}
|
|
352
|
+
interface Status {
|
|
353
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
354
|
+
code?: number;
|
|
355
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
356
|
+
details?: Array<{ [P in string]: any }>;
|
|
357
|
+
/**
|
|
358
|
+
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
|
|
359
|
+
* client.
|
|
360
|
+
*/
|
|
361
|
+
message?: string;
|
|
362
|
+
}
|
|
363
|
+
interface TimeOfDay {
|
|
364
|
+
/** Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
|
|
365
|
+
hours?: number;
|
|
366
|
+
/** Minutes of hour of day. Must be from 0 to 59. */
|
|
367
|
+
minutes?: number;
|
|
368
|
+
/** Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */
|
|
369
|
+
nanos?: number;
|
|
370
|
+
/** Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */
|
|
371
|
+
seconds?: number;
|
|
372
|
+
}
|
|
373
|
+
interface TransferCounters {
|
|
374
|
+
/** Bytes that are copied to the data sink. */
|
|
375
|
+
bytesCopiedToSink?: string;
|
|
376
|
+
/** Bytes that are deleted from the data sink. */
|
|
377
|
+
bytesDeletedFromSink?: string;
|
|
378
|
+
/** Bytes that are deleted from the data source. */
|
|
379
|
+
bytesDeletedFromSource?: string;
|
|
380
|
+
/** Bytes that failed to be deleted from the data sink. */
|
|
381
|
+
bytesFailedToDeleteFromSink?: string;
|
|
382
|
+
/** Bytes found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync. */
|
|
383
|
+
bytesFoundFromSource?: string;
|
|
384
|
+
/** Bytes found only in the data sink that are scheduled to be deleted. */
|
|
385
|
+
bytesFoundOnlyFromSink?: string;
|
|
386
|
+
/** Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred. */
|
|
387
|
+
bytesFromSourceFailed?: string;
|
|
388
|
+
/** Bytes in the data source that are not transferred because they already exist in the data sink. */
|
|
389
|
+
bytesFromSourceSkippedBySync?: string;
|
|
390
|
+
/**
|
|
391
|
+
* For transfers involving PosixFilesystem only. Number of listing failures for each directory found at the source. Potential failures when listing a directory include permission
|
|
392
|
+
* failure or block failure. If listing a directory fails, no files in the directory are transferred.
|
|
393
|
+
*/
|
|
394
|
+
directoriesFailedToListFromSource?: string;
|
|
395
|
+
/**
|
|
396
|
+
* For transfers involving PosixFilesystem only. Number of directories found while listing. For example, if the root directory of the transfer is `base/` and there are two other
|
|
397
|
+
* directories, `a/` and `b/` under this directory, the count after listing `base/`, `base/a/` and `base/b/` is 3.
|
|
398
|
+
*/
|
|
399
|
+
directoriesFoundFromSource?: string;
|
|
400
|
+
/** For transfers involving PosixFilesystem only. Number of successful listings for each directory found at the source. */
|
|
401
|
+
directoriesSuccessfullyListedFromSource?: string;
|
|
402
|
+
/** Number of successfully cleaned up intermediate objects. */
|
|
403
|
+
intermediateObjectsCleanedUp?: string;
|
|
404
|
+
/** Number of intermediate objects failed cleaned up. */
|
|
405
|
+
intermediateObjectsFailedCleanedUp?: string;
|
|
406
|
+
/** Objects that are copied to the data sink. */
|
|
407
|
+
objectsCopiedToSink?: string;
|
|
408
|
+
/** Objects that are deleted from the data sink. */
|
|
409
|
+
objectsDeletedFromSink?: string;
|
|
410
|
+
/** Objects that are deleted from the data source. */
|
|
411
|
+
objectsDeletedFromSource?: string;
|
|
412
|
+
/** Objects that failed to be deleted from the data sink. */
|
|
413
|
+
objectsFailedToDeleteFromSink?: string;
|
|
414
|
+
/** Objects found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync. */
|
|
415
|
+
objectsFoundFromSource?: string;
|
|
416
|
+
/** Objects found only in the data sink that are scheduled to be deleted. */
|
|
417
|
+
objectsFoundOnlyFromSink?: string;
|
|
418
|
+
/** Objects in the data source that failed to be transferred or that failed to be deleted after being transferred. */
|
|
419
|
+
objectsFromSourceFailed?: string;
|
|
420
|
+
/** Objects in the data source that are not transferred because they already exist in the data sink. */
|
|
421
|
+
objectsFromSourceSkippedBySync?: string;
|
|
422
|
+
}
|
|
423
|
+
interface TransferJob {
|
|
424
|
+
/** Output only. The time that the transfer job was created. */
|
|
425
|
+
creationTime?: string;
|
|
426
|
+
/** Output only. The time that the transfer job was deleted. */
|
|
427
|
+
deletionTime?: string;
|
|
428
|
+
/** A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. */
|
|
429
|
+
description?: string;
|
|
430
|
+
/** Output only. The time that the transfer job was last modified. */
|
|
431
|
+
lastModificationTime?: string;
|
|
432
|
+
/** The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig. */
|
|
433
|
+
latestOperationName?: string;
|
|
434
|
+
/** Logging configuration. */
|
|
435
|
+
loggingConfig?: LoggingConfig;
|
|
436
|
+
/**
|
|
437
|
+
* A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name.
|
|
438
|
+
* Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name
|
|
439
|
+
* must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involving PosixFilesystem, this name must start
|
|
440
|
+
* with `transferJobs/OPI` specifically. For all other transfer types, this name must not start with `transferJobs/OPI`. Non-PosixFilesystem example:
|
|
441
|
+
* `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` PosixFilesystem example: `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Applications must not rely on the enforcement of
|
|
442
|
+
* naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error.
|
|
443
|
+
*/
|
|
444
|
+
name?: string;
|
|
445
|
+
/** Notification configuration. This is not supported for transfers involving PosixFilesystem. */
|
|
446
|
+
notificationConfig?: NotificationConfig;
|
|
447
|
+
/** The ID of the Google Cloud project that owns the job. */
|
|
448
|
+
projectId?: string;
|
|
449
|
+
/**
|
|
450
|
+
* Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job
|
|
451
|
+
* to have a non-empty schedule.
|
|
452
|
+
*/
|
|
453
|
+
schedule?: Schedule;
|
|
454
|
+
/**
|
|
455
|
+
* Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if
|
|
456
|
+
* you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.
|
|
457
|
+
*/
|
|
458
|
+
status?: string;
|
|
459
|
+
/** Transfer specification. */
|
|
460
|
+
transferSpec?: TransferSpec;
|
|
461
|
+
}
|
|
462
|
+
interface TransferManifest {
|
|
463
|
+
/**
|
|
464
|
+
* Specifies the path to the manifest in Cloud Storage. The Google-managed service account for the transfer must have `storage.objects.get` permission for this object. An example path
|
|
465
|
+
* is `gs://bucket_name/path/manifest.csv`.
|
|
466
|
+
*/
|
|
467
|
+
location?: string;
|
|
468
|
+
}
|
|
469
|
+
interface TransferOperation {
|
|
470
|
+
/** Information about the progress of the transfer operation. */
|
|
471
|
+
counters?: TransferCounters;
|
|
472
|
+
/** End time of this transfer execution. */
|
|
473
|
+
endTime?: string;
|
|
474
|
+
/** Summarizes errors encountered with sample error log entries. */
|
|
475
|
+
errorBreakdowns?: ErrorSummary[];
|
|
476
|
+
/** A globally unique ID assigned by the system. */
|
|
477
|
+
name?: string;
|
|
478
|
+
/** Notification configuration. */
|
|
479
|
+
notificationConfig?: NotificationConfig;
|
|
480
|
+
/** The ID of the Google Cloud project that owns the operation. */
|
|
481
|
+
projectId?: string;
|
|
482
|
+
/** Start time of this transfer execution. */
|
|
483
|
+
startTime?: string;
|
|
484
|
+
/** Status of the transfer operation. */
|
|
485
|
+
status?: string;
|
|
486
|
+
/** The name of the transfer job that triggers this transfer operation. */
|
|
487
|
+
transferJobName?: string;
|
|
488
|
+
/** Transfer specification. */
|
|
489
|
+
transferSpec?: TransferSpec;
|
|
490
|
+
}
|
|
491
|
+
interface TransferOptions {
|
|
492
|
+
/** Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink are mutually exclusive. */
|
|
493
|
+
deleteObjectsFromSourceAfterTransfer?: boolean;
|
|
494
|
+
/** Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive. */
|
|
495
|
+
deleteObjectsUniqueInSink?: boolean;
|
|
496
|
+
/** Represents the selected metadata options for a transfer job. */
|
|
497
|
+
metadataOptions?: MetadataOptions;
|
|
498
|
+
/**
|
|
499
|
+
* When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose
|
|
500
|
+
* name matches an object in the source are overwritten with the source object.
|
|
501
|
+
*/
|
|
502
|
+
overwriteObjectsAlreadyExistingInSink?: boolean;
|
|
503
|
+
/** When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink. */
|
|
504
|
+
overwriteWhen?: string;
|
|
505
|
+
}
|
|
506
|
+
interface TransferSpec {
|
|
507
|
+
/** An AWS S3 compatible data source. */
|
|
508
|
+
awsS3CompatibleDataSource?: AwsS3CompatibleData;
|
|
509
|
+
/** An AWS S3 data source. */
|
|
510
|
+
awsS3DataSource?: AwsS3Data;
|
|
511
|
+
/** An Azure Blob Storage data source. */
|
|
512
|
+
azureBlobStorageDataSource?: AzureBlobStorageData;
|
|
513
|
+
/** A Cloud Storage data sink. */
|
|
514
|
+
gcsDataSink?: GcsData;
|
|
515
|
+
/** A Cloud Storage data source. */
|
|
516
|
+
gcsDataSource?: GcsData;
|
|
517
|
+
/** Cloud Storage intermediate data location. */
|
|
518
|
+
gcsIntermediateDataLocation?: GcsData;
|
|
519
|
+
/** An HTTP URL data source. */
|
|
520
|
+
httpDataSource?: HttpData;
|
|
521
|
+
/**
|
|
522
|
+
* Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' "last modification time" do not
|
|
523
|
+
* exclude objects in a data sink.
|
|
524
|
+
*/
|
|
525
|
+
objectConditions?: ObjectConditions;
|
|
526
|
+
/** A POSIX Filesystem data sink. */
|
|
527
|
+
posixDataSink?: PosixFilesystem;
|
|
528
|
+
/** A POSIX Filesystem data source. */
|
|
529
|
+
posixDataSource?: PosixFilesystem;
|
|
530
|
+
/** Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used. */
|
|
531
|
+
sinkAgentPoolName?: string;
|
|
532
|
+
/** Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used. */
|
|
533
|
+
sourceAgentPoolName?: string;
|
|
534
|
+
/**
|
|
535
|
+
* A manifest file provides a list of objects to be transferred from the data source. This field points to the location of the manifest file. Otherwise, the entire source bucket is
|
|
536
|
+
* used. ObjectConditions still apply.
|
|
537
|
+
*/
|
|
538
|
+
transferManifest?: TransferManifest;
|
|
539
|
+
/**
|
|
540
|
+
* If the option delete_objects_unique_in_sink is `true` and time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT
|
|
541
|
+
* error.
|
|
542
|
+
*/
|
|
543
|
+
transferOptions?: TransferOptions;
|
|
544
|
+
}
|
|
545
|
+
interface UpdateTransferJobRequest {
|
|
546
|
+
/** Required. The ID of the Google Cloud project that owns the job. */
|
|
547
|
+
projectId?: string;
|
|
548
|
+
/**
|
|
549
|
+
* Required. The job to update. `transferJob` is expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. An
|
|
550
|
+
* `UpdateTransferJobRequest` that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires `storagetransfer.jobs.delete`
|
|
551
|
+
* permissions.
|
|
552
|
+
*/
|
|
553
|
+
transferJob?: TransferJob;
|
|
554
|
+
/**
|
|
555
|
+
* The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: description, transfer_spec,
|
|
556
|
+
* notification_config, logging_config, and status. To update the `transfer_spec` of the job, a complete transfer specification must be provided. An incomplete specification missing
|
|
557
|
+
* any required fields is rejected with the error INVALID_ARGUMENT.
|
|
558
|
+
*/
|
|
559
|
+
updateTransferJobFieldMask?: string;
|
|
560
|
+
}
|
|
561
|
+
interface GoogleServiceAccountsResource {
|
|
562
|
+
/**
|
|
563
|
+
* Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is
|
|
564
|
+
* associated with one Google Cloud project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service
|
|
565
|
+
* account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.
|
|
566
|
+
*/
|
|
567
|
+
get(request?: {
|
|
568
|
+
/** V1 error format. */
|
|
569
|
+
"$.xgafv"?: string;
|
|
570
|
+
/** OAuth access token. */
|
|
571
|
+
access_token?: string;
|
|
572
|
+
/** Data format for response. */
|
|
573
|
+
alt?: string;
|
|
574
|
+
/** JSONP */
|
|
575
|
+
callback?: string;
|
|
576
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
577
|
+
fields?: string;
|
|
578
|
+
/** 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. */
|
|
579
|
+
key?: string;
|
|
580
|
+
/** OAuth 2.0 token for the current user. */
|
|
581
|
+
oauth_token?: string;
|
|
582
|
+
/** Returns response with indentations and line breaks. */
|
|
583
|
+
prettyPrint?: boolean;
|
|
584
|
+
/** Required. The ID of the Google Cloud project that the Google service account is associated with. */
|
|
585
|
+
projectId: string;
|
|
586
|
+
/** 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. */
|
|
587
|
+
quotaUser?: string;
|
|
588
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
589
|
+
upload_protocol?: string;
|
|
590
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
591
|
+
uploadType?: string;
|
|
592
|
+
}): Request<GoogleServiceAccount>;
|
|
593
|
+
}
|
|
594
|
+
interface AgentPoolsResource {
|
|
595
|
+
/** Creates an agent pool resource. */
|
|
596
|
+
create(request: {
|
|
597
|
+
/** V1 error format. */
|
|
598
|
+
"$.xgafv"?: string;
|
|
599
|
+
/** OAuth access token. */
|
|
600
|
+
access_token?: string;
|
|
601
|
+
/**
|
|
602
|
+
* Required. The ID of the agent pool to create. The `agent_pool_id` must meet the following requirements: * Length of 128 characters or less. * Not start with the string `goog`. *
|
|
603
|
+
* Start with a lowercase ASCII character, followed by: * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (`-`), periods (`.`), underscores (`_`), or tildes
|
|
604
|
+
* (`~`). * One or more numerals or lowercase ASCII characters. As expressed by the regular expression: `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.
|
|
605
|
+
*/
|
|
606
|
+
agentPoolId?: string;
|
|
607
|
+
/** Data format for response. */
|
|
608
|
+
alt?: string;
|
|
609
|
+
/** JSONP */
|
|
610
|
+
callback?: string;
|
|
611
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
612
|
+
fields?: string;
|
|
613
|
+
/** 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. */
|
|
614
|
+
key?: string;
|
|
615
|
+
/** OAuth 2.0 token for the current user. */
|
|
616
|
+
oauth_token?: string;
|
|
617
|
+
/** Returns response with indentations and line breaks. */
|
|
618
|
+
prettyPrint?: boolean;
|
|
619
|
+
/** Required. The ID of the Google Cloud project that owns the agent pool. */
|
|
620
|
+
projectId: string;
|
|
621
|
+
/** 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. */
|
|
622
|
+
quotaUser?: string;
|
|
623
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
624
|
+
upload_protocol?: string;
|
|
625
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
626
|
+
uploadType?: string;
|
|
627
|
+
/** Request body */
|
|
628
|
+
resource: AgentPool;
|
|
629
|
+
}): Request<AgentPool>;
|
|
630
|
+
create(request: {
|
|
631
|
+
/** V1 error format. */
|
|
632
|
+
"$.xgafv"?: string;
|
|
633
|
+
/** OAuth access token. */
|
|
634
|
+
access_token?: string;
|
|
635
|
+
/**
|
|
636
|
+
* Required. The ID of the agent pool to create. The `agent_pool_id` must meet the following requirements: * Length of 128 characters or less. * Not start with the string `goog`. *
|
|
637
|
+
* Start with a lowercase ASCII character, followed by: * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (`-`), periods (`.`), underscores (`_`), or tildes
|
|
638
|
+
* (`~`). * One or more numerals or lowercase ASCII characters. As expressed by the regular expression: `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.
|
|
639
|
+
*/
|
|
640
|
+
agentPoolId?: string;
|
|
641
|
+
/** Data format for response. */
|
|
642
|
+
alt?: string;
|
|
643
|
+
/** JSONP */
|
|
644
|
+
callback?: string;
|
|
645
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
646
|
+
fields?: string;
|
|
647
|
+
/** 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. */
|
|
648
|
+
key?: string;
|
|
649
|
+
/** OAuth 2.0 token for the current user. */
|
|
650
|
+
oauth_token?: string;
|
|
651
|
+
/** Returns response with indentations and line breaks. */
|
|
652
|
+
prettyPrint?: boolean;
|
|
653
|
+
/** Required. The ID of the Google Cloud project that owns the agent pool. */
|
|
654
|
+
projectId: string;
|
|
655
|
+
/** 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. */
|
|
656
|
+
quotaUser?: string;
|
|
657
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
658
|
+
upload_protocol?: string;
|
|
659
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
660
|
+
uploadType?: string;
|
|
661
|
+
},
|
|
662
|
+
body: AgentPool): Request<AgentPool>;
|
|
663
|
+
/** Deletes an agent pool. */
|
|
664
|
+
delete(request?: {
|
|
665
|
+
/** V1 error format. */
|
|
666
|
+
"$.xgafv"?: string;
|
|
667
|
+
/** OAuth access token. */
|
|
668
|
+
access_token?: string;
|
|
669
|
+
/** Data format for response. */
|
|
670
|
+
alt?: string;
|
|
671
|
+
/** JSONP */
|
|
672
|
+
callback?: string;
|
|
673
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
674
|
+
fields?: string;
|
|
675
|
+
/** 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. */
|
|
676
|
+
key?: string;
|
|
677
|
+
/** Required. The name of the agent pool to delete. */
|
|
678
|
+
name: string;
|
|
679
|
+
/** OAuth 2.0 token for the current user. */
|
|
680
|
+
oauth_token?: string;
|
|
681
|
+
/** Returns response with indentations and line breaks. */
|
|
682
|
+
prettyPrint?: boolean;
|
|
683
|
+
/** 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. */
|
|
684
|
+
quotaUser?: string;
|
|
685
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
686
|
+
upload_protocol?: string;
|
|
687
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
688
|
+
uploadType?: string;
|
|
689
|
+
}): Request<{}>;
|
|
690
|
+
/** Gets an agent pool. */
|
|
691
|
+
get(request?: {
|
|
692
|
+
/** V1 error format. */
|
|
693
|
+
"$.xgafv"?: string;
|
|
694
|
+
/** OAuth access token. */
|
|
695
|
+
access_token?: string;
|
|
696
|
+
/** Data format for response. */
|
|
697
|
+
alt?: string;
|
|
698
|
+
/** JSONP */
|
|
699
|
+
callback?: string;
|
|
700
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
701
|
+
fields?: string;
|
|
702
|
+
/** 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. */
|
|
703
|
+
key?: string;
|
|
704
|
+
/** Required. The name of the agent pool to get. */
|
|
705
|
+
name: string;
|
|
706
|
+
/** OAuth 2.0 token for the current user. */
|
|
707
|
+
oauth_token?: string;
|
|
708
|
+
/** Returns response with indentations and line breaks. */
|
|
709
|
+
prettyPrint?: boolean;
|
|
710
|
+
/** 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. */
|
|
711
|
+
quotaUser?: string;
|
|
712
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
713
|
+
upload_protocol?: string;
|
|
714
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
715
|
+
uploadType?: string;
|
|
716
|
+
}): Request<AgentPool>;
|
|
717
|
+
/** Lists agent pools. */
|
|
718
|
+
list(request?: {
|
|
719
|
+
/** V1 error format. */
|
|
720
|
+
"$.xgafv"?: string;
|
|
721
|
+
/** OAuth access token. */
|
|
722
|
+
access_token?: string;
|
|
723
|
+
/** Data format for response. */
|
|
724
|
+
alt?: string;
|
|
725
|
+
/** JSONP */
|
|
726
|
+
callback?: string;
|
|
727
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
728
|
+
fields?: string;
|
|
729
|
+
/**
|
|
730
|
+
* An optional list of query parameters specified as JSON text in the form of: `{"agentPoolNames":["agentpool1","agentpool2",...]}` Since `agentPoolNames` support multiple values,
|
|
731
|
+
* its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.
|
|
732
|
+
*/
|
|
733
|
+
filter?: string;
|
|
734
|
+
/** 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. */
|
|
735
|
+
key?: string;
|
|
736
|
+
/** OAuth 2.0 token for the current user. */
|
|
737
|
+
oauth_token?: string;
|
|
738
|
+
/** The list page size. The max allowed value is `256`. */
|
|
739
|
+
pageSize?: number;
|
|
740
|
+
/** The list page token. */
|
|
741
|
+
pageToken?: string;
|
|
742
|
+
/** Returns response with indentations and line breaks. */
|
|
743
|
+
prettyPrint?: boolean;
|
|
744
|
+
/** Required. The ID of the Google Cloud project that owns the job. */
|
|
745
|
+
projectId: string;
|
|
746
|
+
/** 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. */
|
|
747
|
+
quotaUser?: string;
|
|
748
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
749
|
+
upload_protocol?: string;
|
|
750
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
751
|
+
uploadType?: string;
|
|
752
|
+
}): Request<ListAgentPoolsResponse>;
|
|
753
|
+
/** Updates an existing agent pool resource. */
|
|
754
|
+
patch(request: {
|
|
755
|
+
/** V1 error format. */
|
|
756
|
+
"$.xgafv"?: string;
|
|
757
|
+
/** OAuth access token. */
|
|
758
|
+
access_token?: string;
|
|
759
|
+
/** Data format for response. */
|
|
760
|
+
alt?: string;
|
|
761
|
+
/** JSONP */
|
|
762
|
+
callback?: string;
|
|
763
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
764
|
+
fields?: string;
|
|
765
|
+
/** 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. */
|
|
766
|
+
key?: string;
|
|
767
|
+
/** Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` */
|
|
768
|
+
name: string;
|
|
769
|
+
/** OAuth 2.0 token for the current user. */
|
|
770
|
+
oauth_token?: string;
|
|
771
|
+
/** Returns response with indentations and line breaks. */
|
|
772
|
+
prettyPrint?: boolean;
|
|
773
|
+
/** 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. */
|
|
774
|
+
quotaUser?: string;
|
|
775
|
+
/**
|
|
776
|
+
* The [field mask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in `agentPool` to update in this request. The following
|
|
777
|
+
* `agentPool` fields can be updated: * display_name * bandwidth_limit
|
|
778
|
+
*/
|
|
779
|
+
updateMask?: string;
|
|
780
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
781
|
+
upload_protocol?: string;
|
|
782
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
783
|
+
uploadType?: string;
|
|
784
|
+
/** Request body */
|
|
785
|
+
resource: AgentPool;
|
|
786
|
+
}): Request<AgentPool>;
|
|
787
|
+
patch(request: {
|
|
788
|
+
/** V1 error format. */
|
|
789
|
+
"$.xgafv"?: string;
|
|
790
|
+
/** OAuth access token. */
|
|
791
|
+
access_token?: string;
|
|
792
|
+
/** Data format for response. */
|
|
793
|
+
alt?: string;
|
|
794
|
+
/** JSONP */
|
|
795
|
+
callback?: string;
|
|
796
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
797
|
+
fields?: string;
|
|
798
|
+
/** 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. */
|
|
799
|
+
key?: string;
|
|
800
|
+
/** Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` */
|
|
801
|
+
name: string;
|
|
802
|
+
/** OAuth 2.0 token for the current user. */
|
|
803
|
+
oauth_token?: string;
|
|
804
|
+
/** Returns response with indentations and line breaks. */
|
|
805
|
+
prettyPrint?: boolean;
|
|
806
|
+
/** 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. */
|
|
807
|
+
quotaUser?: string;
|
|
808
|
+
/**
|
|
809
|
+
* The [field mask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in `agentPool` to update in this request. The following
|
|
810
|
+
* `agentPool` fields can be updated: * display_name * bandwidth_limit
|
|
811
|
+
*/
|
|
812
|
+
updateMask?: string;
|
|
813
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
814
|
+
upload_protocol?: string;
|
|
815
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
816
|
+
uploadType?: string;
|
|
817
|
+
},
|
|
818
|
+
body: AgentPool): Request<AgentPool>;
|
|
819
|
+
}
|
|
820
|
+
interface ProjectsResource {
|
|
821
|
+
agentPools: AgentPoolsResource;
|
|
822
|
+
}
|
|
823
|
+
interface TransferJobsResource {
|
|
824
|
+
/** Creates a transfer job that runs periodically. */
|
|
825
|
+
create(request: {
|
|
826
|
+
/** V1 error format. */
|
|
827
|
+
"$.xgafv"?: string;
|
|
828
|
+
/** OAuth access token. */
|
|
829
|
+
access_token?: string;
|
|
830
|
+
/** Data format for response. */
|
|
831
|
+
alt?: string;
|
|
832
|
+
/** JSONP */
|
|
833
|
+
callback?: string;
|
|
834
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
835
|
+
fields?: string;
|
|
836
|
+
/** 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. */
|
|
837
|
+
key?: string;
|
|
838
|
+
/** OAuth 2.0 token for the current user. */
|
|
839
|
+
oauth_token?: string;
|
|
840
|
+
/** Returns response with indentations and line breaks. */
|
|
841
|
+
prettyPrint?: boolean;
|
|
842
|
+
/** 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. */
|
|
843
|
+
quotaUser?: string;
|
|
844
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
845
|
+
upload_protocol?: string;
|
|
846
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
847
|
+
uploadType?: string;
|
|
848
|
+
/** Request body */
|
|
849
|
+
resource: TransferJob;
|
|
850
|
+
}): Request<TransferJob>;
|
|
851
|
+
create(request: {
|
|
852
|
+
/** V1 error format. */
|
|
853
|
+
"$.xgafv"?: string;
|
|
854
|
+
/** OAuth access token. */
|
|
855
|
+
access_token?: string;
|
|
856
|
+
/** Data format for response. */
|
|
857
|
+
alt?: string;
|
|
858
|
+
/** JSONP */
|
|
859
|
+
callback?: string;
|
|
860
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
861
|
+
fields?: string;
|
|
862
|
+
/** 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. */
|
|
863
|
+
key?: string;
|
|
864
|
+
/** OAuth 2.0 token for the current user. */
|
|
865
|
+
oauth_token?: string;
|
|
866
|
+
/** Returns response with indentations and line breaks. */
|
|
867
|
+
prettyPrint?: boolean;
|
|
868
|
+
/** 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. */
|
|
869
|
+
quotaUser?: string;
|
|
870
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
871
|
+
upload_protocol?: string;
|
|
872
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
873
|
+
uploadType?: string;
|
|
874
|
+
},
|
|
875
|
+
body: TransferJob): Request<TransferJob>;
|
|
876
|
+
/** Gets a transfer job. */
|
|
877
|
+
get(request?: {
|
|
878
|
+
/** V1 error format. */
|
|
879
|
+
"$.xgafv"?: string;
|
|
880
|
+
/** OAuth access token. */
|
|
881
|
+
access_token?: string;
|
|
882
|
+
/** Data format for response. */
|
|
883
|
+
alt?: string;
|
|
884
|
+
/** JSONP */
|
|
885
|
+
callback?: string;
|
|
886
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
887
|
+
fields?: string;
|
|
888
|
+
/** Required. The job to get. */
|
|
889
|
+
jobName: string;
|
|
890
|
+
/** 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. */
|
|
891
|
+
key?: string;
|
|
892
|
+
/** OAuth 2.0 token for the current user. */
|
|
893
|
+
oauth_token?: string;
|
|
894
|
+
/** Returns response with indentations and line breaks. */
|
|
895
|
+
prettyPrint?: boolean;
|
|
896
|
+
/** Required. The ID of the Google Cloud project that owns the job. */
|
|
897
|
+
projectId: string;
|
|
898
|
+
/** 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. */
|
|
899
|
+
quotaUser?: string;
|
|
900
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
901
|
+
upload_protocol?: string;
|
|
902
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
903
|
+
uploadType?: string;
|
|
904
|
+
}): Request<TransferJob>;
|
|
905
|
+
/** Lists transfer jobs. */
|
|
906
|
+
list(request?: {
|
|
907
|
+
/** V1 error format. */
|
|
908
|
+
"$.xgafv"?: string;
|
|
909
|
+
/** OAuth access token. */
|
|
910
|
+
access_token?: string;
|
|
911
|
+
/** Data format for response. */
|
|
912
|
+
alt?: string;
|
|
913
|
+
/** JSONP */
|
|
914
|
+
callback?: string;
|
|
915
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
916
|
+
fields?: string;
|
|
917
|
+
/**
|
|
918
|
+
* Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...],
|
|
919
|
+
* "jobStatuses":["status1","status2",...]}` Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `projectId` is
|
|
920
|
+
* required. `jobNames` and `jobStatuses` are optional. The valid values for `jobStatuses` are case-insensitive: ENABLED, DISABLED, and DELETED.
|
|
921
|
+
*/
|
|
922
|
+
filter: string;
|
|
923
|
+
/** 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. */
|
|
924
|
+
key?: string;
|
|
925
|
+
/** OAuth 2.0 token for the current user. */
|
|
926
|
+
oauth_token?: string;
|
|
927
|
+
/** The list page size. The max allowed value is 256. */
|
|
928
|
+
pageSize?: number;
|
|
929
|
+
/** The list page token. */
|
|
930
|
+
pageToken?: string;
|
|
931
|
+
/** Returns response with indentations and line breaks. */
|
|
932
|
+
prettyPrint?: boolean;
|
|
933
|
+
/** 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. */
|
|
934
|
+
quotaUser?: string;
|
|
935
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
936
|
+
upload_protocol?: string;
|
|
937
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
938
|
+
uploadType?: string;
|
|
939
|
+
}): Request<ListTransferJobsResponse>;
|
|
940
|
+
/**
|
|
941
|
+
* Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. **Note:** The job's status field can be modified using this RPC
|
|
942
|
+
* (for example, to set a job's status to DELETED, DISABLED, or ENABLED).
|
|
943
|
+
*/
|
|
944
|
+
patch(request: {
|
|
945
|
+
/** V1 error format. */
|
|
946
|
+
"$.xgafv"?: string;
|
|
947
|
+
/** OAuth access token. */
|
|
948
|
+
access_token?: string;
|
|
949
|
+
/** Data format for response. */
|
|
950
|
+
alt?: string;
|
|
951
|
+
/** JSONP */
|
|
952
|
+
callback?: string;
|
|
953
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
954
|
+
fields?: string;
|
|
955
|
+
/** Required. The name of job to update. */
|
|
956
|
+
jobName: string;
|
|
957
|
+
/** 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. */
|
|
958
|
+
key?: string;
|
|
959
|
+
/** OAuth 2.0 token for the current user. */
|
|
960
|
+
oauth_token?: string;
|
|
961
|
+
/** Returns response with indentations and line breaks. */
|
|
962
|
+
prettyPrint?: boolean;
|
|
963
|
+
/** 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. */
|
|
964
|
+
quotaUser?: string;
|
|
965
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
966
|
+
upload_protocol?: string;
|
|
967
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
968
|
+
uploadType?: string;
|
|
969
|
+
/** Request body */
|
|
970
|
+
resource: UpdateTransferJobRequest;
|
|
971
|
+
}): Request<TransferJob>;
|
|
972
|
+
patch(request: {
|
|
973
|
+
/** V1 error format. */
|
|
974
|
+
"$.xgafv"?: string;
|
|
975
|
+
/** OAuth access token. */
|
|
976
|
+
access_token?: string;
|
|
977
|
+
/** Data format for response. */
|
|
978
|
+
alt?: string;
|
|
979
|
+
/** JSONP */
|
|
980
|
+
callback?: string;
|
|
981
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
982
|
+
fields?: string;
|
|
983
|
+
/** Required. The name of job to update. */
|
|
984
|
+
jobName: string;
|
|
985
|
+
/** 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. */
|
|
986
|
+
key?: string;
|
|
987
|
+
/** OAuth 2.0 token for the current user. */
|
|
988
|
+
oauth_token?: string;
|
|
989
|
+
/** Returns response with indentations and line breaks. */
|
|
990
|
+
prettyPrint?: boolean;
|
|
991
|
+
/** 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. */
|
|
992
|
+
quotaUser?: string;
|
|
993
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
994
|
+
upload_protocol?: string;
|
|
995
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
996
|
+
uploadType?: string;
|
|
997
|
+
},
|
|
998
|
+
body: UpdateTransferJobRequest): Request<TransferJob>;
|
|
999
|
+
/**
|
|
1000
|
+
* Attempts to start a new TransferOperation for the current TransferJob. A TransferJob has a maximum of one active TransferOperation. If this method is called while a
|
|
1001
|
+
* TransferOperation is active, an error will be returned.
|
|
1002
|
+
*/
|
|
1003
|
+
run(request: {
|
|
1004
|
+
/** V1 error format. */
|
|
1005
|
+
"$.xgafv"?: string;
|
|
1006
|
+
/** OAuth access token. */
|
|
1007
|
+
access_token?: string;
|
|
1008
|
+
/** Data format for response. */
|
|
1009
|
+
alt?: string;
|
|
1010
|
+
/** JSONP */
|
|
1011
|
+
callback?: string;
|
|
1012
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1013
|
+
fields?: string;
|
|
1014
|
+
/** Required. The name of the transfer job. */
|
|
1015
|
+
jobName: string;
|
|
1016
|
+
/** 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. */
|
|
1017
|
+
key?: string;
|
|
1018
|
+
/** OAuth 2.0 token for the current user. */
|
|
1019
|
+
oauth_token?: string;
|
|
1020
|
+
/** Returns response with indentations and line breaks. */
|
|
1021
|
+
prettyPrint?: boolean;
|
|
1022
|
+
/** 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. */
|
|
1023
|
+
quotaUser?: string;
|
|
1024
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1025
|
+
upload_protocol?: string;
|
|
1026
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1027
|
+
uploadType?: string;
|
|
1028
|
+
/** Request body */
|
|
1029
|
+
resource: RunTransferJobRequest;
|
|
1030
|
+
}): Request<Operation>;
|
|
1031
|
+
run(request: {
|
|
1032
|
+
/** V1 error format. */
|
|
1033
|
+
"$.xgafv"?: string;
|
|
1034
|
+
/** OAuth access token. */
|
|
1035
|
+
access_token?: string;
|
|
1036
|
+
/** Data format for response. */
|
|
1037
|
+
alt?: string;
|
|
1038
|
+
/** JSONP */
|
|
1039
|
+
callback?: string;
|
|
1040
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1041
|
+
fields?: string;
|
|
1042
|
+
/** Required. The name of the transfer job. */
|
|
1043
|
+
jobName: string;
|
|
1044
|
+
/** 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. */
|
|
1045
|
+
key?: string;
|
|
1046
|
+
/** OAuth 2.0 token for the current user. */
|
|
1047
|
+
oauth_token?: string;
|
|
1048
|
+
/** Returns response with indentations and line breaks. */
|
|
1049
|
+
prettyPrint?: boolean;
|
|
1050
|
+
/** 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. */
|
|
1051
|
+
quotaUser?: string;
|
|
1052
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1053
|
+
upload_protocol?: string;
|
|
1054
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1055
|
+
uploadType?: string;
|
|
1056
|
+
},
|
|
1057
|
+
body: RunTransferJobRequest): Request<Operation>;
|
|
1058
|
+
}
|
|
1059
|
+
interface TransferOperationsResource {
|
|
1060
|
+
/**
|
|
1061
|
+
* Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the `cancel` request. When you cancel an
|
|
1062
|
+
* operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured
|
|
1063
|
+
* to run every day at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop. However, a transfer job will still be attempted on Tuesday. This applies only to
|
|
1064
|
+
* currently running operations. If an operation is not currently running, `cancel` does nothing. *Caution:* Canceling a transfer job can leave your data in an unknown state. We
|
|
1065
|
+
* recommend that you restore the state at both the destination and the source after the `cancel` request completes so that your data is in a consistent state. When you cancel a job,
|
|
1066
|
+
* the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today's job found 10 new files and transferred five files
|
|
1067
|
+
* before you canceled the job, tomorrow's transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow.
|
|
1068
|
+
*/
|
|
1069
|
+
cancel(request: {
|
|
1070
|
+
/** V1 error format. */
|
|
1071
|
+
"$.xgafv"?: string;
|
|
1072
|
+
/** OAuth access token. */
|
|
1073
|
+
access_token?: string;
|
|
1074
|
+
/** Data format for response. */
|
|
1075
|
+
alt?: string;
|
|
1076
|
+
/** JSONP */
|
|
1077
|
+
callback?: string;
|
|
1078
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1079
|
+
fields?: string;
|
|
1080
|
+
/** 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. */
|
|
1081
|
+
key?: string;
|
|
1082
|
+
/** The name of the operation resource to be cancelled. */
|
|
1083
|
+
name: string;
|
|
1084
|
+
/** OAuth 2.0 token for the current user. */
|
|
1085
|
+
oauth_token?: string;
|
|
1086
|
+
/** Returns response with indentations and line breaks. */
|
|
1087
|
+
prettyPrint?: boolean;
|
|
1088
|
+
/** 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. */
|
|
1089
|
+
quotaUser?: string;
|
|
1090
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1091
|
+
upload_protocol?: string;
|
|
1092
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1093
|
+
uploadType?: string;
|
|
1094
|
+
/** Request body */
|
|
1095
|
+
resource: CancelOperationRequest;
|
|
1096
|
+
}): Request<{}>;
|
|
1097
|
+
cancel(request: {
|
|
1098
|
+
/** V1 error format. */
|
|
1099
|
+
"$.xgafv"?: string;
|
|
1100
|
+
/** OAuth access token. */
|
|
1101
|
+
access_token?: string;
|
|
1102
|
+
/** Data format for response. */
|
|
1103
|
+
alt?: string;
|
|
1104
|
+
/** JSONP */
|
|
1105
|
+
callback?: string;
|
|
1106
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1107
|
+
fields?: string;
|
|
1108
|
+
/** 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. */
|
|
1109
|
+
key?: string;
|
|
1110
|
+
/** The name of the operation resource to be cancelled. */
|
|
1111
|
+
name: string;
|
|
1112
|
+
/** OAuth 2.0 token for the current user. */
|
|
1113
|
+
oauth_token?: string;
|
|
1114
|
+
/** Returns response with indentations and line breaks. */
|
|
1115
|
+
prettyPrint?: boolean;
|
|
1116
|
+
/** 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. */
|
|
1117
|
+
quotaUser?: string;
|
|
1118
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1119
|
+
upload_protocol?: string;
|
|
1120
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1121
|
+
uploadType?: string;
|
|
1122
|
+
},
|
|
1123
|
+
body: CancelOperationRequest): Request<{}>;
|
|
1124
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
1125
|
+
get(request?: {
|
|
1126
|
+
/** V1 error format. */
|
|
1127
|
+
"$.xgafv"?: string;
|
|
1128
|
+
/** OAuth access token. */
|
|
1129
|
+
access_token?: string;
|
|
1130
|
+
/** Data format for response. */
|
|
1131
|
+
alt?: string;
|
|
1132
|
+
/** JSONP */
|
|
1133
|
+
callback?: string;
|
|
1134
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1135
|
+
fields?: string;
|
|
1136
|
+
/** 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. */
|
|
1137
|
+
key?: string;
|
|
1138
|
+
/** The name of the operation resource. */
|
|
1139
|
+
name: string;
|
|
1140
|
+
/** OAuth 2.0 token for the current user. */
|
|
1141
|
+
oauth_token?: string;
|
|
1142
|
+
/** Returns response with indentations and line breaks. */
|
|
1143
|
+
prettyPrint?: boolean;
|
|
1144
|
+
/** 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. */
|
|
1145
|
+
quotaUser?: string;
|
|
1146
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1147
|
+
upload_protocol?: string;
|
|
1148
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1149
|
+
uploadType?: string;
|
|
1150
|
+
}): Request<Operation>;
|
|
1151
|
+
/** Lists transfer operations. Operations are ordered by their creation time in reverse chronological order. */
|
|
1152
|
+
list(request?: {
|
|
1153
|
+
/** V1 error format. */
|
|
1154
|
+
"$.xgafv"?: string;
|
|
1155
|
+
/** OAuth access token. */
|
|
1156
|
+
access_token?: string;
|
|
1157
|
+
/** Data format for response. */
|
|
1158
|
+
alt?: string;
|
|
1159
|
+
/** JSONP */
|
|
1160
|
+
callback?: string;
|
|
1161
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1162
|
+
fields?: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...],
|
|
1165
|
+
* "operationNames":["opid1","opid2",...], "transferStatuses":["status1","status2",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they
|
|
1166
|
+
* must be specified with array notation. `projectId` is required. `jobNames`, `operationNames`, and `transferStatuses` are optional. The valid values for `transferStatuses` are
|
|
1167
|
+
* case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.
|
|
1168
|
+
*/
|
|
1169
|
+
filter: string;
|
|
1170
|
+
/** 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. */
|
|
1171
|
+
key?: string;
|
|
1172
|
+
/** Required. The name of the type being listed; must be `transferOperations`. */
|
|
1173
|
+
name: string;
|
|
1174
|
+
/** OAuth 2.0 token for the current user. */
|
|
1175
|
+
oauth_token?: string;
|
|
1176
|
+
/** The list page size. The max allowed value is 256. */
|
|
1177
|
+
pageSize?: number;
|
|
1178
|
+
/** The list page token. */
|
|
1179
|
+
pageToken?: string;
|
|
1180
|
+
/** Returns response with indentations and line breaks. */
|
|
1181
|
+
prettyPrint?: boolean;
|
|
1182
|
+
/** 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. */
|
|
1183
|
+
quotaUser?: string;
|
|
1184
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1185
|
+
upload_protocol?: string;
|
|
1186
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1187
|
+
uploadType?: string;
|
|
1188
|
+
}): Request<ListOperationsResponse>;
|
|
1189
|
+
/** Pauses a transfer operation. */
|
|
1190
|
+
pause(request: {
|
|
1191
|
+
/** V1 error format. */
|
|
1192
|
+
"$.xgafv"?: string;
|
|
1193
|
+
/** OAuth access token. */
|
|
1194
|
+
access_token?: string;
|
|
1195
|
+
/** Data format for response. */
|
|
1196
|
+
alt?: string;
|
|
1197
|
+
/** JSONP */
|
|
1198
|
+
callback?: string;
|
|
1199
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1200
|
+
fields?: string;
|
|
1201
|
+
/** 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. */
|
|
1202
|
+
key?: string;
|
|
1203
|
+
/** Required. The name of the transfer operation. */
|
|
1204
|
+
name: string;
|
|
1205
|
+
/** OAuth 2.0 token for the current user. */
|
|
1206
|
+
oauth_token?: string;
|
|
1207
|
+
/** Returns response with indentations and line breaks. */
|
|
1208
|
+
prettyPrint?: boolean;
|
|
1209
|
+
/** 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. */
|
|
1210
|
+
quotaUser?: string;
|
|
1211
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1212
|
+
upload_protocol?: string;
|
|
1213
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1214
|
+
uploadType?: string;
|
|
1215
|
+
/** Request body */
|
|
1216
|
+
resource: PauseTransferOperationRequest;
|
|
1217
|
+
}): Request<{}>;
|
|
1218
|
+
pause(request: {
|
|
1219
|
+
/** V1 error format. */
|
|
1220
|
+
"$.xgafv"?: string;
|
|
1221
|
+
/** OAuth access token. */
|
|
1222
|
+
access_token?: string;
|
|
1223
|
+
/** Data format for response. */
|
|
1224
|
+
alt?: string;
|
|
1225
|
+
/** JSONP */
|
|
1226
|
+
callback?: string;
|
|
1227
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1228
|
+
fields?: string;
|
|
1229
|
+
/** 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. */
|
|
1230
|
+
key?: string;
|
|
1231
|
+
/** Required. The name of the transfer operation. */
|
|
1232
|
+
name: string;
|
|
1233
|
+
/** OAuth 2.0 token for the current user. */
|
|
1234
|
+
oauth_token?: string;
|
|
1235
|
+
/** Returns response with indentations and line breaks. */
|
|
1236
|
+
prettyPrint?: boolean;
|
|
1237
|
+
/** 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. */
|
|
1238
|
+
quotaUser?: string;
|
|
1239
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1240
|
+
upload_protocol?: string;
|
|
1241
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1242
|
+
uploadType?: string;
|
|
1243
|
+
},
|
|
1244
|
+
body: PauseTransferOperationRequest): Request<{}>;
|
|
1245
|
+
/** Resumes a transfer operation that is paused. */
|
|
1246
|
+
resume(request: {
|
|
1247
|
+
/** V1 error format. */
|
|
1248
|
+
"$.xgafv"?: string;
|
|
1249
|
+
/** OAuth access token. */
|
|
1250
|
+
access_token?: string;
|
|
1251
|
+
/** Data format for response. */
|
|
1252
|
+
alt?: string;
|
|
1253
|
+
/** JSONP */
|
|
1254
|
+
callback?: string;
|
|
1255
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1256
|
+
fields?: string;
|
|
1257
|
+
/** 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. */
|
|
1258
|
+
key?: string;
|
|
1259
|
+
/** Required. The name of the transfer operation. */
|
|
1260
|
+
name: string;
|
|
1261
|
+
/** OAuth 2.0 token for the current user. */
|
|
1262
|
+
oauth_token?: string;
|
|
1263
|
+
/** Returns response with indentations and line breaks. */
|
|
1264
|
+
prettyPrint?: boolean;
|
|
1265
|
+
/** 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. */
|
|
1266
|
+
quotaUser?: string;
|
|
1267
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1268
|
+
upload_protocol?: string;
|
|
1269
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1270
|
+
uploadType?: string;
|
|
1271
|
+
/** Request body */
|
|
1272
|
+
resource: ResumeTransferOperationRequest;
|
|
1273
|
+
}): Request<{}>;
|
|
1274
|
+
resume(request: {
|
|
1275
|
+
/** V1 error format. */
|
|
1276
|
+
"$.xgafv"?: string;
|
|
1277
|
+
/** OAuth access token. */
|
|
1278
|
+
access_token?: string;
|
|
1279
|
+
/** Data format for response. */
|
|
1280
|
+
alt?: string;
|
|
1281
|
+
/** JSONP */
|
|
1282
|
+
callback?: string;
|
|
1283
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1284
|
+
fields?: string;
|
|
1285
|
+
/** 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. */
|
|
1286
|
+
key?: string;
|
|
1287
|
+
/** Required. The name of the transfer operation. */
|
|
1288
|
+
name: string;
|
|
1289
|
+
/** OAuth 2.0 token for the current user. */
|
|
1290
|
+
oauth_token?: string;
|
|
1291
|
+
/** Returns response with indentations and line breaks. */
|
|
1292
|
+
prettyPrint?: boolean;
|
|
1293
|
+
/** 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. */
|
|
1294
|
+
quotaUser?: string;
|
|
1295
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1296
|
+
upload_protocol?: string;
|
|
1297
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1298
|
+
uploadType?: string;
|
|
1299
|
+
},
|
|
1300
|
+
body: ResumeTransferOperationRequest): Request<{}>;
|
|
1301
|
+
}
|
|
1302
|
+
|
|
1303
|
+
const googleServiceAccounts: GoogleServiceAccountsResource;
|
|
1304
|
+
|
|
1305
|
+
const projects: ProjectsResource;
|
|
1306
|
+
|
|
1307
|
+
const transferJobs: TransferJobsResource;
|
|
1308
|
+
|
|
1309
|
+
const transferOperations: TransferOperationsResource;
|
|
1310
|
+
}
|
|
1311
|
+
}
|