| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 } |
| 8 } |
| 9 } |
| 10 }, |
| 11 "basePath": "", |
| 12 "baseUrl": "https://storagetransfer.googleapis.com/", |
| 13 "batchPath": "batch", |
| 14 "description": "Transfers data from external data sources to a Google Cloud
Storage bucket or between Google Cloud Storage buckets.", |
| 15 "discoveryVersion": "v1", |
| 16 "documentationLink": "https://cloud.google.com/storage/transfer", |
| 17 "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/8WMJiL8K16v_wlyCbIDiawRcHDI\"", |
| 18 "icons": { |
| 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 21 }, |
| 22 "id": "storagetransfer:v1", |
| 23 "kind": "discovery#restDescription", |
| 24 "name": "storagetransfer", |
| 25 "ownerDomain": "google.com", |
| 26 "ownerName": "Google", |
| 27 "parameters": { |
| 28 "access_token": { |
| 29 "description": "OAuth access token.", |
| 30 "location": "query", |
| 31 "type": "string" |
| 32 }, |
| 33 "alt": { |
| 34 "default": "json", |
| 35 "description": "Data format for response.", |
| 36 "enumDescriptions": [ |
| 37 "Responses with Content-Type of application/json", |
| 38 "Media download with context-dependent Content-Type", |
| 39 "Responses with Content-Type of application/x-protobuf" |
| 40 ], |
| 41 "location": "query", |
| 42 "type": "string" |
| 43 }, |
| 44 "bearer_token": { |
| 45 "description": "OAuth bearer token.", |
| 46 "location": "query", |
| 47 "type": "string" |
| 48 }, |
| 49 "callback": { |
| 50 "description": "JSONP", |
| 51 "location": "query", |
| 52 "type": "string" |
| 53 }, |
| 54 "fields": { |
| 55 "description": "Selector specifying which fields to include in a par
tial response.", |
| 56 "location": "query", |
| 57 "type": "string" |
| 58 }, |
| 59 "key": { |
| 60 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 61 "location": "query", |
| 62 "type": "string" |
| 63 }, |
| 64 "oauth_token": { |
| 65 "description": "OAuth 2.0 token for the current user.", |
| 66 "location": "query", |
| 67 "type": "string" |
| 68 }, |
| 69 "pp": { |
| 70 "default": "true", |
| 71 "description": "Pretty-print response.", |
| 72 "location": "query", |
| 73 "type": "boolean" |
| 74 }, |
| 75 "prettyPrint": { |
| 76 "default": "true", |
| 77 "description": "Returns response with indentations and line breaks."
, |
| 78 "location": "query", |
| 79 "type": "boolean" |
| 80 }, |
| 81 "quotaUser": { |
| 82 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 83 "location": "query", |
| 84 "type": "string" |
| 85 }, |
| 86 "upload_protocol": { |
| 87 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 88 "location": "query", |
| 89 "type": "string" |
| 90 }, |
| 91 "uploadType": { |
| 92 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 93 "location": "query", |
| 94 "type": "string" |
| 95 }, |
| 96 "$.xgafv": { |
| 97 "description": "V1 error format.", |
| 98 "enumDescriptions": [ |
| 99 "v1 error format", |
| 100 "v2 error format" |
| 101 ], |
| 102 "location": "query", |
| 103 "type": "string" |
| 104 } |
| 105 }, |
| 106 "protocol": "rest", |
| 107 "resources": { |
| 108 "googleServiceAccounts": { |
| 109 "methods": { |
| 110 "get": { |
| 111 "description": "Returns the Google service account that is u
sed by Storage Transfer Service to access buckets in the project where transfers
run or in other projects. Each Google service account is associated with one Go
ogle Developers Console project. Users should add this service account to the Go
ogle Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This
service account is created and owned by Storage Transfer Service and can only b
e used by Storage Transfer Service.", |
| 112 "httpMethod": "GET", |
| 113 "id": "storagetransfer.googleServiceAccounts.get", |
| 114 "parameterOrder": [ |
| 115 "projectId" |
| 116 ], |
| 117 "parameters": { |
| 118 "projectId": { |
| 119 "description": "The ID of the Google Developers Cons
ole project that the Google service account is associated with. Required.", |
| 120 "location": "path", |
| 121 "required": true, |
| 122 "type": "string" |
| 123 } |
| 124 }, |
| 125 "path": "v1/googleServiceAccounts/{projectId}", |
| 126 "response": { |
| 127 "$ref": "GoogleServiceAccount" |
| 128 }, |
| 129 "scopes": [ |
| 130 "https://www.googleapis.com/auth/cloud-platform" |
| 131 ] |
| 132 } |
| 133 } |
| 134 }, |
| 135 "v1": { |
| 136 "methods": { |
| 137 "getGoogleServiceAccount": { |
| 138 "description": "Returns the Google service account that is u
sed by Storage Transfer Service to access buckets in the project where transfers
run or in other projects. Each Google service account is associated with one Go
ogle Developers Console project. Users should add this service account to the Go
ogle Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This
service account is created and owned by Storage Transfer Service and can only b
e used by Storage Transfer Service.", |
| 139 "httpMethod": "GET", |
| 140 "id": "storagetransfer.getGoogleServiceAccount", |
| 141 "parameters": { |
| 142 "projectId": { |
| 143 "description": "The ID of the Google Developers Cons
ole project that the Google service account is associated with. Required.", |
| 144 "location": "query", |
| 145 "type": "string" |
| 146 } |
| 147 }, |
| 148 "path": "v1:getGoogleServiceAccount", |
| 149 "response": { |
| 150 "$ref": "GoogleServiceAccount" |
| 151 }, |
| 152 "scopes": [ |
| 153 "https://www.googleapis.com/auth/cloud-platform" |
| 154 ] |
| 155 } |
| 156 } |
| 157 }, |
| 158 "transferJobs": { |
| 159 "methods": { |
| 160 "create": { |
| 161 "description": "Creates a transfer job that runs periodicall
y.", |
| 162 "httpMethod": "POST", |
| 163 "id": "storagetransfer.transferJobs.create", |
| 164 "path": "v1/transferJobs", |
| 165 "request": { |
| 166 "$ref": "TransferJob" |
| 167 }, |
| 168 "response": { |
| 169 "$ref": "TransferJob" |
| 170 }, |
| 171 "scopes": [ |
| 172 "https://www.googleapis.com/auth/cloud-platform" |
| 173 ] |
| 174 }, |
| 175 "patch": { |
| 176 "description": "Updates a transfer job. Updating a job's tra
nsfer spec does not affect transfer operations that are running already. Updatin
g the scheduling of a job is not allowed.", |
| 177 "httpMethod": "PATCH", |
| 178 "id": "storagetransfer.transferJobs.patch", |
| 179 "parameterOrder": [ |
| 180 "jobName" |
| 181 ], |
| 182 "parameters": { |
| 183 "jobName": { |
| 184 "description": "The name of job to update. Required.
", |
| 185 "location": "path", |
| 186 "pattern": "^transferJobs/.*$", |
| 187 "required": true, |
| 188 "type": "string" |
| 189 } |
| 190 }, |
| 191 "path": "v1/{+jobName}", |
| 192 "request": { |
| 193 "$ref": "UpdateTransferJobRequest" |
| 194 }, |
| 195 "response": { |
| 196 "$ref": "TransferJob" |
| 197 }, |
| 198 "scopes": [ |
| 199 "https://www.googleapis.com/auth/cloud-platform" |
| 200 ] |
| 201 }, |
| 202 "get": { |
| 203 "description": "Gets a transfer job.", |
| 204 "httpMethod": "GET", |
| 205 "id": "storagetransfer.transferJobs.get", |
| 206 "parameterOrder": [ |
| 207 "jobName" |
| 208 ], |
| 209 "parameters": { |
| 210 "jobName": { |
| 211 "description": "The job to get. Required.", |
| 212 "location": "path", |
| 213 "pattern": "^transferJobs/.*$", |
| 214 "required": true, |
| 215 "type": "string" |
| 216 }, |
| 217 "projectId": { |
| 218 "description": "The ID of the Google Developers Cons
ole project that owns the job. Required.", |
| 219 "location": "query", |
| 220 "type": "string" |
| 221 } |
| 222 }, |
| 223 "path": "v1/{+jobName}", |
| 224 "response": { |
| 225 "$ref": "TransferJob" |
| 226 }, |
| 227 "scopes": [ |
| 228 "https://www.googleapis.com/auth/cloud-platform" |
| 229 ] |
| 230 }, |
| 231 "list": { |
| 232 "description": "Lists transfer jobs.", |
| 233 "httpMethod": "GET", |
| 234 "id": "storagetransfer.transferJobs.list", |
| 235 "parameters": { |
| 236 "filter": { |
| 237 "description": "A list of query parameters specified
as JSON text in the form of {\"`project_id`\":\"my_project_id\", \"`job_names`\
":[\"jobid1\",\"jobid2\",...], \"`job_statuses`\":[\"status1\",\"status2\",...]}
. Since `job_names` and `job_statuses` support multiple values, their values mus
t be specified with array notation. `project_id` is required. `job_names` and `j
ob_statuses` are optional. The valid values for `job_statuses` are case-insensit
ive: `ENABLED`, `DISABLED`, and `DELETED`.", |
| 238 "location": "query", |
| 239 "type": "string" |
| 240 }, |
| 241 "pageSize": { |
| 242 "description": "The list page size. The max allowed
value is 256.", |
| 243 "format": "int32", |
| 244 "location": "query", |
| 245 "type": "integer" |
| 246 }, |
| 247 "pageToken": { |
| 248 "description": "The list page token.", |
| 249 "location": "query", |
| 250 "type": "string" |
| 251 } |
| 252 }, |
| 253 "path": "v1/transferJobs", |
| 254 "response": { |
| 255 "$ref": "ListTransferJobsResponse" |
| 256 }, |
| 257 "scopes": [ |
| 258 "https://www.googleapis.com/auth/cloud-platform" |
| 259 ] |
| 260 } |
| 261 } |
| 262 }, |
| 263 "transferOperations": { |
| 264 "methods": { |
| 265 "pause": { |
| 266 "description": "Pauses a transfer operation.", |
| 267 "httpMethod": "POST", |
| 268 "id": "storagetransfer.transferOperations.pause", |
| 269 "parameterOrder": [ |
| 270 "name" |
| 271 ], |
| 272 "parameters": { |
| 273 "name": { |
| 274 "description": "The name of the transfer operation.
Required.", |
| 275 "location": "path", |
| 276 "pattern": "^transferOperations/.*$", |
| 277 "required": true, |
| 278 "type": "string" |
| 279 } |
| 280 }, |
| 281 "path": "v1/{+name}:pause", |
| 282 "request": { |
| 283 "$ref": "PauseTransferOperationRequest" |
| 284 }, |
| 285 "response": { |
| 286 "$ref": "Empty" |
| 287 }, |
| 288 "scopes": [ |
| 289 "https://www.googleapis.com/auth/cloud-platform" |
| 290 ] |
| 291 }, |
| 292 "resume": { |
| 293 "description": "Resumes a transfer operation that is paused.
", |
| 294 "httpMethod": "POST", |
| 295 "id": "storagetransfer.transferOperations.resume", |
| 296 "parameterOrder": [ |
| 297 "name" |
| 298 ], |
| 299 "parameters": { |
| 300 "name": { |
| 301 "description": "The name of the transfer operation.
Required.", |
| 302 "location": "path", |
| 303 "pattern": "^transferOperations/.*$", |
| 304 "required": true, |
| 305 "type": "string" |
| 306 } |
| 307 }, |
| 308 "path": "v1/{+name}:resume", |
| 309 "request": { |
| 310 "$ref": "ResumeTransferOperationRequest" |
| 311 }, |
| 312 "response": { |
| 313 "$ref": "Empty" |
| 314 }, |
| 315 "scopes": [ |
| 316 "https://www.googleapis.com/auth/cloud-platform" |
| 317 ] |
| 318 }, |
| 319 "get": { |
| 320 "description": "Gets the latest state of a long-running oper
ation. Clients can use this method to poll the operation result at intervals as
recommended by the API service.", |
| 321 "httpMethod": "GET", |
| 322 "id": "storagetransfer.transferOperations.get", |
| 323 "parameterOrder": [ |
| 324 "name" |
| 325 ], |
| 326 "parameters": { |
| 327 "name": { |
| 328 "description": "The name of the operation resource."
, |
| 329 "location": "path", |
| 330 "pattern": "^transferOperations/.*$", |
| 331 "required": true, |
| 332 "type": "string" |
| 333 } |
| 334 }, |
| 335 "path": "v1/{+name}", |
| 336 "response": { |
| 337 "$ref": "Operation" |
| 338 }, |
| 339 "scopes": [ |
| 340 "https://www.googleapis.com/auth/cloud-platform" |
| 341 ] |
| 342 }, |
| 343 "list": { |
| 344 "description": "Lists operations that match the specified fi
lter in the request. If the server doesn't support this method, it returns `UNIM
PLEMENTED`. NOTE: the `name` binding below allows API services to override the b
inding to use different resource name schemes, such as `users/*/operations`.", |
| 345 "httpMethod": "GET", |
| 346 "id": "storagetransfer.transferOperations.list", |
| 347 "parameterOrder": [ |
| 348 "name" |
| 349 ], |
| 350 "parameters": { |
| 351 "name": { |
| 352 "description": "The value `transferOperations`.", |
| 353 "location": "path", |
| 354 "pattern": "^transferOperations$", |
| 355 "required": true, |
| 356 "type": "string" |
| 357 }, |
| 358 "filter": { |
| 359 "description": "The standard list filter.", |
| 360 "location": "query", |
| 361 "type": "string" |
| 362 }, |
| 363 "pageSize": { |
| 364 "description": "The standard list page size.", |
| 365 "format": "int32", |
| 366 "location": "query", |
| 367 "type": "integer" |
| 368 }, |
| 369 "pageToken": { |
| 370 "description": "The standard list page token.", |
| 371 "location": "query", |
| 372 "type": "string" |
| 373 } |
| 374 }, |
| 375 "path": "v1/{+name}", |
| 376 "response": { |
| 377 "$ref": "ListOperationsResponse" |
| 378 }, |
| 379 "scopes": [ |
| 380 "https://www.googleapis.com/auth/cloud-platform" |
| 381 ] |
| 382 }, |
| 383 "cancel": { |
| 384 "description": "Cancels a transfer. Use the get method to ch
eck whether the cancellation succeeded or whether the operation completed despit
e cancellation.", |
| 385 "httpMethod": "POST", |
| 386 "id": "storagetransfer.transferOperations.cancel", |
| 387 "parameterOrder": [ |
| 388 "name" |
| 389 ], |
| 390 "parameters": { |
| 391 "name": { |
| 392 "description": "The name of the operation resource t
o be cancelled.", |
| 393 "location": "path", |
| 394 "pattern": "^transferOperations/.*$", |
| 395 "required": true, |
| 396 "type": "string" |
| 397 } |
| 398 }, |
| 399 "path": "v1/{+name}:cancel", |
| 400 "response": { |
| 401 "$ref": "Empty" |
| 402 }, |
| 403 "scopes": [ |
| 404 "https://www.googleapis.com/auth/cloud-platform" |
| 405 ] |
| 406 }, |
| 407 "delete": { |
| 408 "description": "This method is not supported and the server
returns `UNIMPLEMENTED`.", |
| 409 "httpMethod": "DELETE", |
| 410 "id": "storagetransfer.transferOperations.delete", |
| 411 "parameterOrder": [ |
| 412 "name" |
| 413 ], |
| 414 "parameters": { |
| 415 "name": { |
| 416 "description": "The name of the operation resource t
o be deleted.", |
| 417 "location": "path", |
| 418 "pattern": "^transferOperations/.*$", |
| 419 "required": true, |
| 420 "type": "string" |
| 421 } |
| 422 }, |
| 423 "path": "v1/{+name}", |
| 424 "response": { |
| 425 "$ref": "Empty" |
| 426 }, |
| 427 "scopes": [ |
| 428 "https://www.googleapis.com/auth/cloud-platform" |
| 429 ] |
| 430 } |
| 431 } |
| 432 } |
| 433 }, |
| 434 "revision": "20150728", |
| 435 "rootUrl": "https://storagetransfer.googleapis.com/", |
| 436 "schemas": { |
| 437 "GoogleServiceAccount": { |
| 438 "description": "Google service account", |
| 439 "id": "GoogleServiceAccount", |
| 440 "properties": { |
| 441 "accountEmail": { |
| 442 "description": "Required.", |
| 443 "type": "string" |
| 444 } |
| 445 }, |
| 446 "type": "object" |
| 447 }, |
| 448 "TransferJob": { |
| 449 "description": "This resource represents the configuration of a tran
sfer job that runs periodically.", |
| 450 "id": "TransferJob", |
| 451 "properties": { |
| 452 "name": { |
| 453 "description": "A globally unique name assigned by Storage T
ransfer Service when the job is created. This field should be left empty in requ
ests to create a new transfer job; otherwise, the requests result in an `INVALID
_ARGUMENT` error.", |
| 454 "type": "string" |
| 455 }, |
| 456 "description": { |
| 457 "description": "A description provided by the user for the j
ob. Its max length is 1024 bytes when Unicode-encoded.", |
| 458 "type": "string" |
| 459 }, |
| 460 "projectId": { |
| 461 "description": "The ID of the Google Developers Console proj
ect that owns the job. Required.", |
| 462 "type": "string" |
| 463 }, |
| 464 "transferSpec": { |
| 465 "$ref": "TransferSpec", |
| 466 "description": "Transfer specification. Required." |
| 467 }, |
| 468 "schedule": { |
| 469 "$ref": "Schedule", |
| 470 "description": "Schedule specification. Required." |
| 471 }, |
| 472 "status": { |
| 473 "description": "Status of the job. This value MUST be specif
ied for `CreateTransferJobRequests`. NOTE: The effect of the new job status take
s place during a subsequent job run. For example, if you change the job status f
rom `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running
, the status change would not affect the current operation.", |
| 474 "enum": [ |
| 475 "STATUS_UNSPECIFIED", |
| 476 "ENABLED", |
| 477 "DISABLED", |
| 478 "DELETED" |
| 479 ], |
| 480 "type": "string" |
| 481 }, |
| 482 "creationTime": { |
| 483 "description": "This field cannot be changed by user request
s.", |
| 484 "type": "string" |
| 485 }, |
| 486 "lastModificationTime": { |
| 487 "description": "This field cannot be changed by user request
s.", |
| 488 "type": "string" |
| 489 }, |
| 490 "deletionTime": { |
| 491 "description": "This field cannot be changed by user request
s.", |
| 492 "type": "string" |
| 493 } |
| 494 }, |
| 495 "type": "object" |
| 496 }, |
| 497 "TransferSpec": { |
| 498 "description": "Configuration for running a transfer.", |
| 499 "id": "TransferSpec", |
| 500 "properties": { |
| 501 "gcsDataSource": { |
| 502 "$ref": "GcsData", |
| 503 "description": "A Google Cloud Storage data source." |
| 504 }, |
| 505 "awsS3DataSource": { |
| 506 "$ref": "AwsS3Data", |
| 507 "description": "An AWS S3 data source." |
| 508 }, |
| 509 "httpDataSource": { |
| 510 "$ref": "HttpData", |
| 511 "description": "An HTTP URL data source." |
| 512 }, |
| 513 "gcsDataSink": { |
| 514 "$ref": "GcsData", |
| 515 "description": "A Google Cloud Storage data sink." |
| 516 }, |
| 517 "objectConditions": { |
| 518 "$ref": "ObjectConditions", |
| 519 "description": "Only objects that satisfy these object condi
tions are included in the set of data source and data sink objects. Object condi
tions based on objects' `lastModificationTime` do not exclude objects in a data
sink." |
| 520 }, |
| 521 "transferOptions": { |
| 522 "$ref": "TransferOptions", |
| 523 "description": "If the option `deleteObjectsUniqueInSink` is
`true`, object conditions based on objects' `lastModificationTime` are ignored
and do not exclude objects in a data source or a data sink." |
| 524 } |
| 525 }, |
| 526 "type": "object" |
| 527 }, |
| 528 "GcsData": { |
| 529 "description": "In a GcsData, an object's name is the Google Cloud S
torage object's name and its `lastModificationTime` refers to the object's updat
ed time, which changes when the content or the metadata of the object is updated
.", |
| 530 "id": "GcsData", |
| 531 "properties": { |
| 532 "bucketName": { |
| 533 "description": "Google Cloud Storage bucket name (see [Bucke
t Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#require
ments)). Required.", |
| 534 "type": "string" |
| 535 } |
| 536 }, |
| 537 "type": "object" |
| 538 }, |
| 539 "AwsS3Data": { |
| 540 "description": "An AwsS3Data can be a data source, but not a data si
nk. In an AwsS3Data, an object's name is the S3 object's key name.", |
| 541 "id": "AwsS3Data", |
| 542 "properties": { |
| 543 "bucketName": { |
| 544 "description": "S3 Bucket name (see [Creating a bucket](http
://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.ht
ml)). Required.", |
| 545 "type": "string" |
| 546 }, |
| 547 "awsAccessKey": { |
| 548 "$ref": "AwsAccessKey", |
| 549 "description": "AWS access key used to sign the API requests
to the AWS S3 bucket. Permissions on the bucket must be granted to the access I
D of the AWS access key. Required." |
| 550 } |
| 551 }, |
| 552 "type": "object" |
| 553 }, |
| 554 "AwsAccessKey": { |
| 555 "description": "AWS access key (see [AWS Security Credentials](http:
//docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).", |
| 556 "id": "AwsAccessKey", |
| 557 "properties": { |
| 558 "accessKeyId": { |
| 559 "description": "AWS access key ID. Required.", |
| 560 "type": "string" |
| 561 }, |
| 562 "secretAccessKey": { |
| 563 "description": "AWS secret access key. This field is not ret
urned in RPC responses. Required.", |
| 564 "type": "string" |
| 565 } |
| 566 }, |
| 567 "type": "object" |
| 568 }, |
| 569 "HttpData": { |
| 570 "description": "An HttpData specifies a list of objects on the web t
o be transferred over HTTP. The information of the objects to be transferred is
contained in a file referenced by a URL. The first line in the file must be \"Ts
vHttpData-1.0\", which specifies the format of the file. Subsequent lines specif
y the information of the list of objects, one object per list entry. Each entry
has the following tab-delimited fields: * HTTP URL * Length * MD5 - This field i
s a base64-encoded MD5 hash of the object An HTTP URL that points to the object
to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an
object with URL `http(s)://hostname:port/` is transferred to the data sink, the
name of the object at the data sink is `/`. Length and MD5 provide the size and
the base64-encoded MD5 hash of the object. If Length does not match the actual
length of the object fetched, the object will not be transferred. If MD5 does no
t match the MD5 computed from the transferred bytes, the object transfer will fa
il. `lastModificationTime` is not available in HttpData objects. The objects tha
t the URL list points to must allow public access. Storage Transfer Service obey
s `robots.txt` rules and requires the HTTP server to support Range requests and
to return a Content-Length header in each response.", |
| 571 "id": "HttpData", |
| 572 "properties": { |
| 573 "listUrl": { |
| 574 "description": "The URL that points to the file that stores
the object list entries. This file must allow public access. Currently, only URL
s with HTTP and HTTPS schemes are supported. Required.", |
| 575 "type": "string" |
| 576 } |
| 577 }, |
| 578 "type": "object" |
| 579 }, |
| 580 "ObjectConditions": { |
| 581 "description": "Conditions that determine which objects will be tran
sferred.", |
| 582 "id": "ObjectConditions", |
| 583 "properties": { |
| 584 "minTimeElapsedSinceLastModification": { |
| 585 "description": "If unspecified, `minTimeElapsedSinceLastModi
fication` takes a zero value and `maxTimeElapsedSinceLastModification` takes the
maximum possible value of Duration. Objects that satisfy the object conditions
must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeEl
apsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModifi
cation`, or not have a `lastModificationTime`.", |
| 586 "type": "string" |
| 587 }, |
| 588 "maxTimeElapsedSinceLastModification": { |
| 589 "description": "`maxTimeElapsedSinceLastModification` is the
complement to `minTimeElapsedSinceLastModification`.", |
| 590 "type": "string" |
| 591 }, |
| 592 "includePrefixes": { |
| 593 "description": "If `includePrefixes` is specified, objects t
hat satisfy the object conditions must have names that start with one of the `in
cludePrefixes` and that do not start with any of the `excludePrefixes`. If `incl
udePrefixes` is not specified, all objects except those that have names starting
with one of the `excludePrefixes` must satisfy the object conditions. Requireme
nts: * Each include-prefix and exclude-prefix can contain any sequence of Unicod
e characters, of max length 1024 bytes when UTF8-encoded, and must not contain C
arriage Return or Line Feed characters. Wildcard matching and regular expression
matching are not supported. * None of the include-prefix or the exclude-prefix
can be empty, if specified. * Each include-prefix must include a distinct portio
n of the object namespace, i.e. no include-prefix may be a prefix of another inc
lude-prefix. * Each exclude-prefix must exclude a distinct portion of the bucket
, i.e., no exclude-prefix may be a prefix of another exclude-prefix`. * If `incl
udePrefixes` is specified, then each exclude-prefix must exclude paths that were
explicitly included by `includePrefixes`. * The max size of `includePrefixes` i
s 20.", |
| 594 "items": { |
| 595 "type": "string" |
| 596 }, |
| 597 "type": "array" |
| 598 }, |
| 599 "excludePrefixes": { |
| 600 "description": "`excludePrefixes` must follow the constraint
s described for `includePrefixes`. The max size of `excludePrefixes` is 20.", |
| 601 "items": { |
| 602 "type": "string" |
| 603 }, |
| 604 "type": "array" |
| 605 } |
| 606 }, |
| 607 "type": "object" |
| 608 }, |
| 609 "TransferOptions": { |
| 610 "description": "TransferOptions uses three boolean parameters to def
ine the actions to be performed on objects in a transfer.", |
| 611 "id": "TransferOptions", |
| 612 "properties": { |
| 613 "overwriteObjectsAlreadyExistingInSink": { |
| 614 "description": "Whether overwriting objects that already exi
st in the sink is allowed.", |
| 615 "type": "boolean" |
| 616 }, |
| 617 "deleteObjectsUniqueInSink": { |
| 618 "description": "Whether objects that exist only in the sink
should be deleted.", |
| 619 "type": "boolean" |
| 620 }, |
| 621 "deleteObjectsFromSourceAfterTransfer": { |
| 622 "description": "Whether objects should be deleted from the s
ource after they are transferred to the sink.", |
| 623 "type": "boolean" |
| 624 } |
| 625 }, |
| 626 "type": "object" |
| 627 }, |
| 628 "Schedule": { |
| 629 "description": "Transfers can be scheduled to recur or to run just o
nce.", |
| 630 "id": "Schedule", |
| 631 "properties": { |
| 632 "scheduleStartDate": { |
| 633 "$ref": "Date", |
| 634 "description": "The first day the recurring transfer is sche
duled to run. Required." |
| 635 }, |
| 636 "scheduleEndDate": { |
| 637 "$ref": "Date", |
| 638 "description": "The last day the recurring transfer will be
run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will
be executed only once." |
| 639 }, |
| 640 "startTimeOfDay": { |
| 641 "$ref": "TimeOfDay", |
| 642 "description": "The time in UTC at which the transfer will b
e scheduled to start in a day. Transfers may start later than this time. If not
specified, transfers are scheduled to start at midnight UTC." |
| 643 } |
| 644 }, |
| 645 "type": "object" |
| 646 }, |
| 647 "Date": { |
| 648 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and time zone are either specified elsewhere or are not signif
icant. The date is relative to the Proleptic Gregorian Calendar. The day may be
0 to represent a year and month where the day is not significant, e.g. credit ca
rd expiration date. The year may be 0 to represent a month and day independent o
f year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.
type.TimeOfDay] and `google.protobuf.Timestamp`.", |
| 649 "id": "Date", |
| 650 "properties": { |
| 651 "year": { |
| 652 "description": "Year of date. Must be from 1 to 9,999, or 0
if specifying a date without a year.", |
| 653 "format": "int32", |
| 654 "type": "integer" |
| 655 }, |
| 656 "month": { |
| 657 "description": "Month of year of date. Must be from 1 to 12.
", |
| 658 "format": "int32", |
| 659 "type": "integer" |
| 660 }, |
| 661 "day": { |
| 662 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0 if specifying a year/month where the day is not si
gificant.", |
| 663 "format": "int32", |
| 664 "type": "integer" |
| 665 } |
| 666 }, |
| 667 "type": "object" |
| 668 }, |
| 669 "TimeOfDay": { |
| 670 "description": "Represents a time of day. The date and time zone are
either not significant or are specified elsewhere. An API may chose to allow le
ap seconds. Related types are [google.type.Date][google.type.Date] and `google.p
rotobuf.Timestamp`.", |
| 671 "id": "TimeOfDay", |
| 672 "properties": { |
| 673 "hours": { |
| 674 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like
business closing time.", |
| 675 "format": "int32", |
| 676 "type": "integer" |
| 677 }, |
| 678 "minutes": { |
| 679 "description": "Minutes of hour of day. Must be from 0 to 59
.", |
| 680 "format": "int32", |
| 681 "type": "integer" |
| 682 }, |
| 683 "seconds": { |
| 684 "description": "Seconds of minutes of the time. Must normall
y be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", |
| 685 "format": "int32", |
| 686 "type": "integer" |
| 687 }, |
| 688 "nanos": { |
| 689 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", |
| 690 "format": "int32", |
| 691 "type": "integer" |
| 692 } |
| 693 }, |
| 694 "type": "object" |
| 695 }, |
| 696 "UpdateTransferJobRequest": { |
| 697 "description": "Request passed to UpdateTransferJob.", |
| 698 "id": "UpdateTransferJobRequest", |
| 699 "properties": { |
| 700 "projectId": { |
| 701 "description": "The ID of the Google Developers Console proj
ect that owns the job. Required.", |
| 702 "type": "string" |
| 703 }, |
| 704 "transferJob": { |
| 705 "$ref": "TransferJob", |
| 706 "description": "The job to update. Required." |
| 707 }, |
| 708 "updateTransferJobFieldMask": { |
| 709 "description": "The field mask of the fields in `transferJob
` that are to be updated in this request. Fields in `transferJob` that can be up
dated are: `description`, `transferSpec`, and `status`. To update the `transferS
pec` of the job, a complete transfer specification has to be provided. An incomp
lete specification which misses any required fields will be rejected with the er
ror `INVALID_ARGUMENT`.", |
| 710 "type": "string" |
| 711 } |
| 712 }, |
| 713 "type": "object" |
| 714 }, |
| 715 "ListTransferJobsResponse": { |
| 716 "description": "Response from ListTransferJobs.", |
| 717 "id": "ListTransferJobsResponse", |
| 718 "properties": { |
| 719 "transferJobs": { |
| 720 "description": "A list of transfer jobs.", |
| 721 "items": { |
| 722 "$ref": "TransferJob" |
| 723 }, |
| 724 "type": "array" |
| 725 }, |
| 726 "nextPageToken": { |
| 727 "description": "The list next page token.", |
| 728 "type": "string" |
| 729 } |
| 730 }, |
| 731 "type": "object" |
| 732 }, |
| 733 "PauseTransferOperationRequest": { |
| 734 "description": "Request passed to PauseTransferOperation.", |
| 735 "id": "PauseTransferOperationRequest", |
| 736 "type": "object" |
| 737 }, |
| 738 "Empty": { |
| 739 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re
presentation for `Empty` is empty JSON object `{}`.", |
| 740 "id": "Empty", |
| 741 "type": "object" |
| 742 }, |
| 743 "ResumeTransferOperationRequest": { |
| 744 "description": "Request passed to ResumeTransferOperation.", |
| 745 "id": "ResumeTransferOperationRequest", |
| 746 "type": "object" |
| 747 }, |
| 748 "Operation": { |
| 749 "description": "This resource represents a long-running operation th
at is the result of a network API call.", |
| 750 "id": "Operation", |
| 751 "properties": { |
| 752 "name": { |
| 753 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. If you use the default HT
TP mapping above, the `name` should have the format of `operations/some/unique/n
ame`.", |
| 754 "type": "string" |
| 755 }, |
| 756 "metadata": { |
| 757 "additionalProperties": { |
| 758 "description": "Properties of the object. Contains field
@ype with type URL.", |
| 759 "type": "any" |
| 760 }, |
| 761 "description": "Represents the transfer operation object.", |
| 762 "type": "object" |
| 763 }, |
| 764 "done": { |
| 765 "description": "If the value is `false`, it means the operat
ion is still in progress. If true, the operation is completed and the `result` i
s available.", |
| 766 "type": "boolean" |
| 767 }, |
| 768 "error": { |
| 769 "$ref": "Status", |
| 770 "description": "The error result of the operation in case of
failure." |
| 771 }, |
| 772 "response": { |
| 773 "additionalProperties": { |
| 774 "description": "Properties of the object. Contains field
@ype with type URL.", |
| 775 "type": "any" |
| 776 }, |
| 777 "description": "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 original method is standard `G
et`/`Create`/`Update`, the response should be the resource. For other methods, t
he response should have the type `XxxResponse`, where `Xxx` is the original meth
od name. For example, if the original method name is `TakeSnapshot()`, the infer
red response type is `TakeSnapshotResponse`.", |
| 778 "type": "object" |
| 779 } |
| 780 }, |
| 781 "type": "object" |
| 782 }, |
| 783 "Status": { |
| 784 "description": "The `Status` type defines a logical error model that
is suitable for different programming environments, including REST APIs and RPC
APIs. It is used by [gRPC](https://github.com/grpc). The error model is designe
d to be: - Simple to use and understand for most users - Flexible enough to meet
unexpected needs # Overview The `Status` message contains three pieces of data:
error code, error message, and error details. The error code should be an enum
value of [google.rpc.Code][google.rpc.Code], but it may accept additional error
codes if needed. The error message should be a developer-facing English message
that helps developers *understand* and *resolve* the error. If a localized user-
facing error message is needed, put the localized message in the error details o
r localize it in the client. The optional error details may contain arbitrary in
formation about the error. There is a predefined set of error detail types in th
e package `google.rpc` which can be used for common error conditions. # Language
mapping The `Status` message is the logical representation of the error model,
but it is not necessarily the actual wire format. When the `Status` message is e
xposed in different client libraries and different wire protocols, it can be map
ped differently. For example, it will likely be mapped to some exceptions in Jav
a, but more likely mapped to some error codes in C. # Other uses The error model
and the `Status` message can be used in a variety of environments, either with
or without APIs, to provide a consistent developer experience across different e
nvironments. Example uses of this error model include: - Partial errors. If a se
rvice needs to return partial errors to the client, it may embed the `Status` in
the normal response to indicate the partial errors. - Workflow errors. A typica
l workflow has multiple steps. Each step may have a `Status` message for error r
eporting purpose. - Batch operations. If a client uses batch request and batch r
esponse, the `Status` message should be used directly inside batch response, one
for each error sub-response. - Asynchronous operations. If an API call embeds a
synchronous operation results in its response, the status of those operations sh
ould be represented directly using the `Status` message. - Logging. If some API
errors are stored in logs, the message `Status` could be used directly after any
stripping needed for security/privacy reasons.", |
| 785 "id": "Status", |
| 786 "properties": { |
| 787 "code": { |
| 788 "description": "The status code, which should be an enum val
ue of [google.rpc.Code][google.rpc.Code].", |
| 789 "format": "int32", |
| 790 "type": "integer" |
| 791 }, |
| 792 "message": { |
| 793 "description": "A developer-facing error message, which shou
ld be in English. Any user-facing error message should be localized and sent in
the [google.rpc.Status.details][google.rpc.Status.details] field, or localized b
y the client.", |
| 794 "type": "string" |
| 795 }, |
| 796 "details": { |
| 797 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", |
| 798 "items": { |
| 799 "additionalProperties": { |
| 800 "description": "Properties of the object. Contains f
ield @ype with type URL.", |
| 801 "type": "any" |
| 802 }, |
| 803 "type": "object" |
| 804 }, |
| 805 "type": "array" |
| 806 } |
| 807 }, |
| 808 "type": "object" |
| 809 }, |
| 810 "ListOperationsResponse": { |
| 811 "description": "The response message for [Operations.ListOperations]
[google.longrunning.Operations.ListOperations].", |
| 812 "id": "ListOperationsResponse", |
| 813 "properties": { |
| 814 "operations": { |
| 815 "description": "A list of operations that matches the specif
ied filter in the request.", |
| 816 "items": { |
| 817 "$ref": "Operation" |
| 818 }, |
| 819 "type": "array" |
| 820 }, |
| 821 "nextPageToken": { |
| 822 "description": "The standard List next-page token.", |
| 823 "type": "string" |
| 824 } |
| 825 }, |
| 826 "type": "object" |
| 827 }, |
| 828 "TransferOperation": { |
| 829 "description": "A description of the execution of a transfer.", |
| 830 "id": "TransferOperation", |
| 831 "properties": { |
| 832 "name": { |
| 833 "description": "A globally unique ID assigned by the system.
", |
| 834 "type": "string" |
| 835 }, |
| 836 "projectId": { |
| 837 "description": "The ID of the Google Developers Console proj
ect that owns the operation. Required.", |
| 838 "type": "string" |
| 839 }, |
| 840 "transferSpec": { |
| 841 "$ref": "TransferSpec", |
| 842 "description": "Transfer specification. Required." |
| 843 }, |
| 844 "startTime": { |
| 845 "description": "Start time of this transfer execution.", |
| 846 "type": "string" |
| 847 }, |
| 848 "endTime": { |
| 849 "description": "End time of this transfer execution.", |
| 850 "type": "string" |
| 851 }, |
| 852 "status": { |
| 853 "description": "Status of the transfer operation.", |
| 854 "enum": [ |
| 855 "STATUS_UNSPECIFIED", |
| 856 "IN_PROGRESS", |
| 857 "PAUSED", |
| 858 "SUCCESS", |
| 859 "FAILED", |
| 860 "ABORTED" |
| 861 ], |
| 862 "type": "string" |
| 863 }, |
| 864 "counters": { |
| 865 "$ref": "TransferCounters", |
| 866 "description": "Information about the progress of the transf
er operation." |
| 867 }, |
| 868 "errorBreakdowns": { |
| 869 "description": "Summarizes errors encountered with sample er
ror log entries.", |
| 870 "items": { |
| 871 "$ref": "ErrorSummary" |
| 872 }, |
| 873 "type": "array" |
| 874 }, |
| 875 "transferJobName": { |
| 876 "description": "The name of the transfer job that triggers t
his transfer operation.", |
| 877 "type": "string" |
| 878 } |
| 879 }, |
| 880 "type": "object" |
| 881 }, |
| 882 "TransferCounters": { |
| 883 "description": "A collection of counters that report the progress of
a transfer operation.", |
| 884 "id": "TransferCounters", |
| 885 "properties": { |
| 886 "objectsFoundFromSource": { |
| 887 "description": "Objects found in the data source that are sc
heduled to be transferred, which will be copied, excluded based on conditions, o
r skipped due to failures.", |
| 888 "format": "int64", |
| 889 "type": "string" |
| 890 }, |
| 891 "bytesFoundFromSource": { |
| 892 "description": "Bytes found in the data source that are sche
duled to be transferred, which will be copied, excluded based on conditions, or
skipped due to failures.", |
| 893 "format": "int64", |
| 894 "type": "string" |
| 895 }, |
| 896 "objectsFoundOnlyFromSink": { |
| 897 "description": "Objects found only in the data sink that are
scheduled to be deleted.", |
| 898 "format": "int64", |
| 899 "type": "string" |
| 900 }, |
| 901 "bytesFoundOnlyFromSink": { |
| 902 "description": "Bytes found only in the data sink that are s
cheduled to be deleted.", |
| 903 "format": "int64", |
| 904 "type": "string" |
| 905 }, |
| 906 "objectsFromSourceSkippedBySync": { |
| 907 "description": "Objects in the data source that are not tran
sferred because they already exist in the data sink.", |
| 908 "format": "int64", |
| 909 "type": "string" |
| 910 }, |
| 911 "bytesFromSourceSkippedBySync": { |
| 912 "description": "Bytes in the data source that are not transf
erred because they already exist in the data sink.", |
| 913 "format": "int64", |
| 914 "type": "string" |
| 915 }, |
| 916 "objectsCopiedToSink": { |
| 917 "description": "Objects that are copied to the data sink.", |
| 918 "format": "int64", |
| 919 "type": "string" |
| 920 }, |
| 921 "bytesCopiedToSink": { |
| 922 "description": "Bytes that are copied to the data sink.", |
| 923 "format": "int64", |
| 924 "type": "string" |
| 925 }, |
| 926 "objectsDeletedFromSource": { |
| 927 "description": "Objects that are deleted from the data sourc
e.", |
| 928 "format": "int64", |
| 929 "type": "string" |
| 930 }, |
| 931 "bytesDeletedFromSource": { |
| 932 "description": "Bytes that are deleted from the data source.
", |
| 933 "format": "int64", |
| 934 "type": "string" |
| 935 }, |
| 936 "objectsDeletedFromSink": { |
| 937 "description": "Objects that are deleted from the data sink.
", |
| 938 "format": "int64", |
| 939 "type": "string" |
| 940 }, |
| 941 "bytesDeletedFromSink": { |
| 942 "description": "Bytes that are deleted from the data sink.", |
| 943 "format": "int64", |
| 944 "type": "string" |
| 945 }, |
| 946 "objectsFromSourceFailed": { |
| 947 "description": "Objects in the data source that failed durin
g the transfer.", |
| 948 "format": "int64", |
| 949 "type": "string" |
| 950 }, |
| 951 "bytesFromSourceFailed": { |
| 952 "description": "Bytes in the data source that failed during
the transfer.", |
| 953 "format": "int64", |
| 954 "type": "string" |
| 955 }, |
| 956 "objectsFailedToDeleteFromSink": { |
| 957 "description": "Objects that failed to be deleted from the d
ata sink.", |
| 958 "format": "int64", |
| 959 "type": "string" |
| 960 }, |
| 961 "bytesFailedToDeleteFromSink": { |
| 962 "description": "Bytes that failed to be deleted from the dat
a sink.", |
| 963 "format": "int64", |
| 964 "type": "string" |
| 965 } |
| 966 }, |
| 967 "type": "object" |
| 968 }, |
| 969 "ErrorSummary": { |
| 970 "description": "A summary of errors by error code, plus a count and
sample error log entries.", |
| 971 "id": "ErrorSummary", |
| 972 "properties": { |
| 973 "errorCode": { |
| 974 "description": "Required.", |
| 975 "enum": [ |
| 976 "OK", |
| 977 "CANCELLED", |
| 978 "UNKNOWN", |
| 979 "INVALID_ARGUMENT", |
| 980 "DEADLINE_EXCEEDED", |
| 981 "NOT_FOUND", |
| 982 "ALREADY_EXISTS", |
| 983 "PERMISSION_DENIED", |
| 984 "UNAUTHENTICATED", |
| 985 "RESOURCE_EXHAUSTED", |
| 986 "FAILED_PRECONDITION", |
| 987 "ABORTED", |
| 988 "OUT_OF_RANGE", |
| 989 "UNIMPLEMENTED", |
| 990 "INTERNAL", |
| 991 "UNAVAILABLE", |
| 992 "DATA_LOSS" |
| 993 ], |
| 994 "type": "string" |
| 995 }, |
| 996 "errorCount": { |
| 997 "description": "Count of this type of error. Required.", |
| 998 "format": "int64", |
| 999 "type": "string" |
| 1000 }, |
| 1001 "errorLogEntries": { |
| 1002 "description": "Error samples.", |
| 1003 "items": { |
| 1004 "$ref": "ErrorLogEntry" |
| 1005 }, |
| 1006 "type": "array" |
| 1007 } |
| 1008 }, |
| 1009 "type": "object" |
| 1010 }, |
| 1011 "ErrorLogEntry": { |
| 1012 "description": "An entry describing an error that has occurred.", |
| 1013 "id": "ErrorLogEntry", |
| 1014 "properties": { |
| 1015 "url": { |
| 1016 "description": "A URL that refers to the target (a data sour
ce, a data sink, or an object) with which the error is associated. Required.", |
| 1017 "type": "string" |
| 1018 }, |
| 1019 "errorDetails": { |
| 1020 "description": "A list of messages that carry the error deta
ils.", |
| 1021 "items": { |
| 1022 "type": "string" |
| 1023 }, |
| 1024 "type": "array" |
| 1025 } |
| 1026 }, |
| 1027 "type": "object" |
| 1028 } |
| 1029 }, |
| 1030 "servicePath": "", |
| 1031 "title": "Google Storage Transfer API", |
| 1032 "version": "v1" |
| 1033 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 1268013003:
Api-roll 21: 2015-08-04 (Closed)
Base URL: git@github.com:dart-lang/googleapis.git@master