1{ 2 "auth": { 3 "oauth2": { 4 "scopes": { 5 "https://www.googleapis.com/auth/cloud-platform": { 6 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." 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/docs", 17 "fullyEncodeReservedExpansion": true, 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 "mtlsRootUrl": "https://storagetransfer.mtls.googleapis.com/", 25 "name": "storagetransfer", 26 "ownerDomain": "google.com", 27 "ownerName": "Google", 28 "parameters": { 29 "$.xgafv": { 30 "description": "V1 error format.", 31 "enum": [ 32 "1", 33 "2" 34 ], 35 "enumDescriptions": [ 36 "v1 error format", 37 "v2 error format" 38 ], 39 "location": "query", 40 "type": "string" 41 }, 42 "access_token": { 43 "description": "OAuth access token.", 44 "location": "query", 45 "type": "string" 46 }, 47 "alt": { 48 "default": "json", 49 "description": "Data format for response.", 50 "enum": [ 51 "json", 52 "media", 53 "proto" 54 ], 55 "enumDescriptions": [ 56 "Responses with Content-Type of application/json", 57 "Media download with context-dependent Content-Type", 58 "Responses with Content-Type of application/x-protobuf" 59 ], 60 "location": "query", 61 "type": "string" 62 }, 63 "callback": { 64 "description": "JSONP", 65 "location": "query", 66 "type": "string" 67 }, 68 "fields": { 69 "description": "Selector specifying which fields to include in a partial response.", 70 "location": "query", 71 "type": "string" 72 }, 73 "key": { 74 "description": "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.", 75 "location": "query", 76 "type": "string" 77 }, 78 "oauth_token": { 79 "description": "OAuth 2.0 token for the current user.", 80 "location": "query", 81 "type": "string" 82 }, 83 "prettyPrint": { 84 "default": "true", 85 "description": "Returns response with indentations and line breaks.", 86 "location": "query", 87 "type": "boolean" 88 }, 89 "quotaUser": { 90 "description": "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.", 91 "location": "query", 92 "type": "string" 93 }, 94 "uploadType": { 95 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", 96 "location": "query", 97 "type": "string" 98 }, 99 "upload_protocol": { 100 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", 101 "location": "query", 102 "type": "string" 103 } 104 }, 105 "protocol": "rest", 106 "resources": { 107 "googleServiceAccounts": { 108 "methods": { 109 "get": { 110 "description": "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 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 account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.", 111 "flatPath": "v1/googleServiceAccounts/{projectId}", 112 "httpMethod": "GET", 113 "id": "storagetransfer.googleServiceAccounts.get", 114 "parameterOrder": [ 115 "projectId" 116 ], 117 "parameters": { 118 "projectId": { 119 "description": "Required. The ID of the Google Cloud project that the Google service account is associated with.", 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 "projects": { 136 "resources": { 137 "agentPools": { 138 "methods": { 139 "create": { 140 "description": "Creates an agent pool resource.", 141 "flatPath": "v1/projects/{projectsId}/agentPools", 142 "httpMethod": "POST", 143 "id": "storagetransfer.projects.agentPools.create", 144 "parameterOrder": [ 145 "projectId" 146 ], 147 "parameters": { 148 "agentPoolId": { 149 "description": "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`. * Start with a lowercase ASCII character, followed by: * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (`-`), periods (`.`), underscores (`_`), or tildes (`~`). * One or more numerals or lowercase ASCII characters. As expressed by the regular expression: `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.", 150 "location": "query", 151 "type": "string" 152 }, 153 "projectId": { 154 "description": "Required. The ID of the Google Cloud project that owns the agent pool.", 155 "location": "path", 156 "pattern": "^[^/]+$", 157 "required": true, 158 "type": "string" 159 } 160 }, 161 "path": "v1/projects/{+projectId}/agentPools", 162 "request": { 163 "$ref": "AgentPool" 164 }, 165 "response": { 166 "$ref": "AgentPool" 167 }, 168 "scopes": [ 169 "https://www.googleapis.com/auth/cloud-platform" 170 ] 171 }, 172 "delete": { 173 "description": "Deletes an agent pool.", 174 "flatPath": "v1/projects/{projectsId}/agentPools/{agentPoolsId}", 175 "httpMethod": "DELETE", 176 "id": "storagetransfer.projects.agentPools.delete", 177 "parameterOrder": [ 178 "name" 179 ], 180 "parameters": { 181 "name": { 182 "description": "Required. The name of the agent pool to delete.", 183 "location": "path", 184 "pattern": "^projects/[^/]+/agentPools/[^/]+$", 185 "required": true, 186 "type": "string" 187 } 188 }, 189 "path": "v1/{+name}", 190 "response": { 191 "$ref": "Empty" 192 }, 193 "scopes": [ 194 "https://www.googleapis.com/auth/cloud-platform" 195 ] 196 }, 197 "get": { 198 "description": "Gets an agent pool.", 199 "flatPath": "v1/projects/{projectsId}/agentPools/{agentPoolsId}", 200 "httpMethod": "GET", 201 "id": "storagetransfer.projects.agentPools.get", 202 "parameterOrder": [ 203 "name" 204 ], 205 "parameters": { 206 "name": { 207 "description": "Required. The name of the agent pool to get.", 208 "location": "path", 209 "pattern": "^projects/[^/]+/agentPools/[^/]+$", 210 "required": true, 211 "type": "string" 212 } 213 }, 214 "path": "v1/{+name}", 215 "response": { 216 "$ref": "AgentPool" 217 }, 218 "scopes": [ 219 "https://www.googleapis.com/auth/cloud-platform" 220 ] 221 }, 222 "list": { 223 "description": "Lists agent pools.", 224 "flatPath": "v1/projects/{projectsId}/agentPools", 225 "httpMethod": "GET", 226 "id": "storagetransfer.projects.agentPools.list", 227 "parameterOrder": [ 228 "projectId" 229 ], 230 "parameters": { 231 "filter": { 232 "description": "An optional list of query parameters specified as JSON text in the form of: `{\"agentPoolNames\":[\"agentpool1\",\"agentpool2\",...]}` Since `agentPoolNames` support multiple values, 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.", 233 "location": "query", 234 "type": "string" 235 }, 236 "pageSize": { 237 "description": "The list page size. The max allowed value is `256`.", 238 "format": "int32", 239 "location": "query", 240 "type": "integer" 241 }, 242 "pageToken": { 243 "description": "The list page token.", 244 "location": "query", 245 "type": "string" 246 }, 247 "projectId": { 248 "description": "Required. The ID of the Google Cloud project that owns the job.", 249 "location": "path", 250 "pattern": "^[^/]+$", 251 "required": true, 252 "type": "string" 253 } 254 }, 255 "path": "v1/projects/{+projectId}/agentPools", 256 "response": { 257 "$ref": "ListAgentPoolsResponse" 258 }, 259 "scopes": [ 260 "https://www.googleapis.com/auth/cloud-platform" 261 ] 262 }, 263 "patch": { 264 "description": "Updates an existing agent pool resource.", 265 "flatPath": "v1/projects/{projectsId}/agentPools/{agentPoolsId}", 266 "httpMethod": "PATCH", 267 "id": "storagetransfer.projects.agentPools.patch", 268 "parameterOrder": [ 269 "name" 270 ], 271 "parameters": { 272 "name": { 273 "description": "Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}`", 274 "location": "path", 275 "pattern": "^projects/[^/]+/agentPools/[^/]+$", 276 "required": true, 277 "type": "string" 278 }, 279 "updateMask": { 280 "description": "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 `agentPool` fields can be updated: * display_name * bandwidth_limit", 281 "format": "google-fieldmask", 282 "location": "query", 283 "type": "string" 284 } 285 }, 286 "path": "v1/{+name}", 287 "request": { 288 "$ref": "AgentPool" 289 }, 290 "response": { 291 "$ref": "AgentPool" 292 }, 293 "scopes": [ 294 "https://www.googleapis.com/auth/cloud-platform" 295 ] 296 } 297 } 298 } 299 } 300 }, 301 "transferJobs": { 302 "methods": { 303 "create": { 304 "description": "Creates a transfer job that runs periodically.", 305 "flatPath": "v1/transferJobs", 306 "httpMethod": "POST", 307 "id": "storagetransfer.transferJobs.create", 308 "parameterOrder": [], 309 "parameters": {}, 310 "path": "v1/transferJobs", 311 "request": { 312 "$ref": "TransferJob" 313 }, 314 "response": { 315 "$ref": "TransferJob" 316 }, 317 "scopes": [ 318 "https://www.googleapis.com/auth/cloud-platform" 319 ] 320 }, 321 "get": { 322 "description": "Gets a transfer job.", 323 "flatPath": "v1/transferJobs/{transferJobsId}", 324 "httpMethod": "GET", 325 "id": "storagetransfer.transferJobs.get", 326 "parameterOrder": [ 327 "jobName", 328 "projectId" 329 ], 330 "parameters": { 331 "jobName": { 332 "description": "Required. The job to get.", 333 "location": "path", 334 "pattern": "^transferJobs/.*$", 335 "required": true, 336 "type": "string" 337 }, 338 "projectId": { 339 "description": "Required. The ID of the Google Cloud project that owns the job.", 340 "location": "query", 341 "required": true, 342 "type": "string" 343 } 344 }, 345 "path": "v1/{+jobName}", 346 "response": { 347 "$ref": "TransferJob" 348 }, 349 "scopes": [ 350 "https://www.googleapis.com/auth/cloud-platform" 351 ] 352 }, 353 "list": { 354 "description": "Lists transfer jobs.", 355 "flatPath": "v1/transferJobs", 356 "httpMethod": "GET", 357 "id": "storagetransfer.transferJobs.list", 358 "parameterOrder": [ 359 "filter" 360 ], 361 "parameters": { 362 "filter": { 363 "description": "Required. A list of query parameters specified as JSON text in the form of: `{\"projectId\":\"my_project_id\", \"jobNames\":[\"jobid1\",\"jobid2\",...], \"jobStatuses\":[\"status1\",\"status2\",...]}` Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `projectId` is required. `jobNames` and `jobStatuses` are optional. The valid values for `jobStatuses` are case-insensitive: ENABLED, DISABLED, and DELETED.", 364 "location": "query", 365 "required": true, 366 "type": "string" 367 }, 368 "pageSize": { 369 "description": "The list page size. The max allowed value is 256.", 370 "format": "int32", 371 "location": "query", 372 "type": "integer" 373 }, 374 "pageToken": { 375 "description": "The list page token.", 376 "location": "query", 377 "type": "string" 378 } 379 }, 380 "path": "v1/transferJobs", 381 "response": { 382 "$ref": "ListTransferJobsResponse" 383 }, 384 "scopes": [ 385 "https://www.googleapis.com/auth/cloud-platform" 386 ] 387 }, 388 "patch": { 389 "description": "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 (for example, to set a job's status to DELETED, DISABLED, or ENABLED).", 390 "flatPath": "v1/transferJobs/{transferJobsId}", 391 "httpMethod": "PATCH", 392 "id": "storagetransfer.transferJobs.patch", 393 "parameterOrder": [ 394 "jobName" 395 ], 396 "parameters": { 397 "jobName": { 398 "description": "Required. The name of job to update.", 399 "location": "path", 400 "pattern": "^transferJobs/.*$", 401 "required": true, 402 "type": "string" 403 } 404 }, 405 "path": "v1/{+jobName}", 406 "request": { 407 "$ref": "UpdateTransferJobRequest" 408 }, 409 "response": { 410 "$ref": "TransferJob" 411 }, 412 "scopes": [ 413 "https://www.googleapis.com/auth/cloud-platform" 414 ] 415 }, 416 "run": { 417 "description": "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 TransferOperation is active, an error wil be returned.", 418 "flatPath": "v1/transferJobs/{transferJobsId}:run", 419 "httpMethod": "POST", 420 "id": "storagetransfer.transferJobs.run", 421 "parameterOrder": [ 422 "jobName" 423 ], 424 "parameters": { 425 "jobName": { 426 "description": "Required. The name of the transfer job.", 427 "location": "path", 428 "pattern": "^transferJobs/.*$", 429 "required": true, 430 "type": "string" 431 } 432 }, 433 "path": "v1/{+jobName}:run", 434 "request": { 435 "$ref": "RunTransferJobRequest" 436 }, 437 "response": { 438 "$ref": "Operation" 439 }, 440 "scopes": [ 441 "https://www.googleapis.com/auth/cloud-platform" 442 ] 443 } 444 } 445 }, 446 "transferOperations": { 447 "methods": { 448 "cancel": { 449 "description": "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 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 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 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 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, 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 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.", 450 "flatPath": "v1/transferOperations/{transferOperationsId}:cancel", 451 "httpMethod": "POST", 452 "id": "storagetransfer.transferOperations.cancel", 453 "parameterOrder": [ 454 "name" 455 ], 456 "parameters": { 457 "name": { 458 "description": "The name of the operation resource to be cancelled.", 459 "location": "path", 460 "pattern": "^transferOperations/.*$", 461 "required": true, 462 "type": "string" 463 } 464 }, 465 "path": "v1/{+name}:cancel", 466 "request": { 467 "$ref": "CancelOperationRequest" 468 }, 469 "response": { 470 "$ref": "Empty" 471 }, 472 "scopes": [ 473 "https://www.googleapis.com/auth/cloud-platform" 474 ] 475 }, 476 "get": { 477 "description": "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.", 478 "flatPath": "v1/transferOperations/{transferOperationsId}", 479 "httpMethod": "GET", 480 "id": "storagetransfer.transferOperations.get", 481 "parameterOrder": [ 482 "name" 483 ], 484 "parameters": { 485 "name": { 486 "description": "The name of the operation resource.", 487 "location": "path", 488 "pattern": "^transferOperations/.*$", 489 "required": true, 490 "type": "string" 491 } 492 }, 493 "path": "v1/{+name}", 494 "response": { 495 "$ref": "Operation" 496 }, 497 "scopes": [ 498 "https://www.googleapis.com/auth/cloud-platform" 499 ] 500 }, 501 "list": { 502 "description": "Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.", 503 "flatPath": "v1/transferOperations", 504 "httpMethod": "GET", 505 "id": "storagetransfer.transferOperations.list", 506 "parameterOrder": [ 507 "name", 508 "filter" 509 ], 510 "parameters": { 511 "filter": { 512 "description": "Required. A list of query parameters specified as JSON text in the form of: `{\"projectId\":\"my_project_id\", \"jobNames\":[\"jobid1\",\"jobid2\",...], \"operationNames\":[\"opid1\",\"opid2\",...], \"transferStatuses\":[\"status1\",\"status2\",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is required. `jobNames`, `operationNames`, and `transferStatuses` are optional. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.", 513 "location": "query", 514 "required": true, 515 "type": "string" 516 }, 517 "name": { 518 "description": "Not used.", 519 "location": "path", 520 "pattern": "^transferOperations$", 521 "required": true, 522 "type": "string" 523 }, 524 "pageSize": { 525 "description": "The list page size. The max allowed value is 256.", 526 "format": "int32", 527 "location": "query", 528 "type": "integer" 529 }, 530 "pageToken": { 531 "description": "The list page token.", 532 "location": "query", 533 "type": "string" 534 } 535 }, 536 "path": "v1/{+name}", 537 "response": { 538 "$ref": "ListOperationsResponse" 539 }, 540 "scopes": [ 541 "https://www.googleapis.com/auth/cloud-platform" 542 ] 543 }, 544 "pause": { 545 "description": "Pauses a transfer operation.", 546 "flatPath": "v1/transferOperations/{transferOperationsId}:pause", 547 "httpMethod": "POST", 548 "id": "storagetransfer.transferOperations.pause", 549 "parameterOrder": [ 550 "name" 551 ], 552 "parameters": { 553 "name": { 554 "description": "Required. The name of the transfer operation.", 555 "location": "path", 556 "pattern": "^transferOperations/.*$", 557 "required": true, 558 "type": "string" 559 } 560 }, 561 "path": "v1/{+name}:pause", 562 "request": { 563 "$ref": "PauseTransferOperationRequest" 564 }, 565 "response": { 566 "$ref": "Empty" 567 }, 568 "scopes": [ 569 "https://www.googleapis.com/auth/cloud-platform" 570 ] 571 }, 572 "resume": { 573 "description": "Resumes a transfer operation that is paused.", 574 "flatPath": "v1/transferOperations/{transferOperationsId}:resume", 575 "httpMethod": "POST", 576 "id": "storagetransfer.transferOperations.resume", 577 "parameterOrder": [ 578 "name" 579 ], 580 "parameters": { 581 "name": { 582 "description": "Required. The name of the transfer operation.", 583 "location": "path", 584 "pattern": "^transferOperations/.*$", 585 "required": true, 586 "type": "string" 587 } 588 }, 589 "path": "v1/{+name}:resume", 590 "request": { 591 "$ref": "ResumeTransferOperationRequest" 592 }, 593 "response": { 594 "$ref": "Empty" 595 }, 596 "scopes": [ 597 "https://www.googleapis.com/auth/cloud-platform" 598 ] 599 } 600 } 601 } 602 }, 603 "revision": "20211217", 604 "rootUrl": "https://storagetransfer.googleapis.com/", 605 "schemas": { 606 "AgentPool": { 607 "description": "Represents an On-Premises Agent pool.", 608 "id": "AgentPool", 609 "properties": { 610 "bandwidthLimit": { 611 "$ref": "BandwidthLimit", 612 "description": "Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'." 613 }, 614 "displayName": { 615 "description": "Specifies the client-specified AgentPool description.", 616 "type": "string" 617 }, 618 "name": { 619 "description": "Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}`", 620 "type": "string" 621 }, 622 "state": { 623 "description": "Output only. Specifies the state of the AgentPool.", 624 "enum": [ 625 "STATE_UNSPECIFIED", 626 "CREATING", 627 "CREATED", 628 "DELETING" 629 ], 630 "enumDescriptions": [ 631 "Default value. This value is unused.", 632 "This is an initialization state. During this stage, the resources such as Pub/Sub topics are allocated for the AgentPool.", 633 "Determines that the AgentPool is created for use. At this state, Agents can join the AgentPool and participate in the transfer jobs in that pool.", 634 "Determines that the AgentPool deletion has been initiated, and all the resources are scheduled to be cleaned up and freed." 635 ], 636 "readOnly": true, 637 "type": "string" 638 } 639 }, 640 "type": "object" 641 }, 642 "AwsAccessKey": { 643 "description": "AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials).", 644 "id": "AwsAccessKey", 645 "properties": { 646 "accessKeyId": { 647 "description": "Required. AWS access key ID.", 648 "type": "string" 649 }, 650 "secretAccessKey": { 651 "description": "Required. AWS secret access key. This field is not returned in RPC responses.", 652 "type": "string" 653 } 654 }, 655 "type": "object" 656 }, 657 "AwsS3Data": { 658 "description": "An AwsS3Data resource can be a data source, but not a data sink. In an AwsS3Data resource, an object's name is the S3 object's key name.", 659 "id": "AwsS3Data", 660 "properties": { 661 "awsAccessKey": { 662 "$ref": "AwsAccessKey", 663 "description": "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. This field is required. For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials)." 664 }, 665 "bucketName": { 666 "description": "Required. S3 Bucket name (see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).", 667 "type": "string" 668 }, 669 "path": { 670 "description": "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 a '/'.", 671 "type": "string" 672 }, 673 "roleArn": { 674 "description": "The Amazon Resource Name (ARN) of the role to support temporary credentials via `AssumeRoleWithWebIdentity`. For more information about ARNs, see [IAM 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 the session using a `AssumeRoleWithWebIdentity` call for the provided role using the GoogleServiceAccount for this project.", 675 "type": "string" 676 } 677 }, 678 "type": "object" 679 }, 680 "AzureBlobStorageData": { 681 "description": "An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints). In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names).", 682 "id": "AzureBlobStorageData", 683 "properties": { 684 "azureCredentials": { 685 "$ref": "AzureCredentials", 686 "description": "Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials)." 687 }, 688 "container": { 689 "description": "Required. The container to transfer from the Azure Storage account.", 690 "type": "string" 691 }, 692 "path": { 693 "description": "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 a '/'.", 694 "type": "string" 695 }, 696 "storageAccount": { 697 "description": "Required. The name of the Azure Storage account.", 698 "type": "string" 699 } 700 }, 701 "type": "object" 702 }, 703 "AzureCredentials": { 704 "description": "Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials).", 705 "id": "AzureCredentials", 706 "properties": { 707 "sasToken": { 708 "description": "Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview).", 709 "type": "string" 710 } 711 }, 712 "type": "object" 713 }, 714 "BandwidthLimit": { 715 "description": "Specifies a bandwidth limit for an agent pool.", 716 "id": "BandwidthLimit", 717 "properties": { 718 "limitMbps": { 719 "description": "Bandwidth rate in megabytes per second, distributed across all the agents in the pool.", 720 "format": "int64", 721 "type": "string" 722 } 723 }, 724 "type": "object" 725 }, 726 "CancelOperationRequest": { 727 "description": "The request message for Operations.CancelOperation.", 728 "id": "CancelOperationRequest", 729 "properties": {}, 730 "type": "object" 731 }, 732 "Date": { 733 "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", 734 "id": "Date", 735 "properties": { 736 "day": { 737 "description": "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.", 738 "format": "int32", 739 "type": "integer" 740 }, 741 "month": { 742 "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", 743 "format": "int32", 744 "type": "integer" 745 }, 746 "year": { 747 "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", 748 "format": "int32", 749 "type": "integer" 750 } 751 }, 752 "type": "object" 753 }, 754 "Empty": { 755 "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 representation for `Empty` is empty JSON object `{}`.", 756 "id": "Empty", 757 "properties": {}, 758 "type": "object" 759 }, 760 "ErrorLogEntry": { 761 "description": "An entry describing an error that has occurred.", 762 "id": "ErrorLogEntry", 763 "properties": { 764 "errorDetails": { 765 "description": "A list of messages that carry the error details.", 766 "items": { 767 "type": "string" 768 }, 769 "type": "array" 770 }, 771 "url": { 772 "description": "Required. A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated.", 773 "type": "string" 774 } 775 }, 776 "type": "object" 777 }, 778 "ErrorSummary": { 779 "description": "A summary of errors by error code, plus a count and sample error log entries.", 780 "id": "ErrorSummary", 781 "properties": { 782 "errorCode": { 783 "description": "Required.", 784 "enum": [ 785 "OK", 786 "CANCELLED", 787 "UNKNOWN", 788 "INVALID_ARGUMENT", 789 "DEADLINE_EXCEEDED", 790 "NOT_FOUND", 791 "ALREADY_EXISTS", 792 "PERMISSION_DENIED", 793 "UNAUTHENTICATED", 794 "RESOURCE_EXHAUSTED", 795 "FAILED_PRECONDITION", 796 "ABORTED", 797 "OUT_OF_RANGE", 798 "UNIMPLEMENTED", 799 "INTERNAL", 800 "UNAVAILABLE", 801 "DATA_LOSS" 802 ], 803 "enumDescriptions": [ 804 "Not an error; returned on success HTTP Mapping: 200 OK", 805 "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", 806 "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", 807 "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", 808 "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", 809 "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", 810 "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", 811 "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", 812 "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", 813 "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", 814 "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", 815 "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", 816 "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", 817 "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", 818 "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", 819 "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", 820 "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" 821 ], 822 "type": "string" 823 }, 824 "errorCount": { 825 "description": "Required. Count of this type of error.", 826 "format": "int64", 827 "type": "string" 828 }, 829 "errorLogEntries": { 830 "description": "Error samples. At most 5 error log entries are recorded for a given error code for a single transfer operation.", 831 "items": { 832 "$ref": "ErrorLogEntry" 833 }, 834 "type": "array" 835 } 836 }, 837 "type": "object" 838 }, 839 "GcsData": { 840 "description": "In a GcsData resource, an object's name is the Cloud Storage object's name and its \"last modification time\" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated.", 841 "id": "GcsData", 842 "properties": { 843 "bucketName": { 844 "description": "Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements).", 845 "type": "string" 846 }, 847 "path": { 848 "description": "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 a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames).", 849 "type": "string" 850 } 851 }, 852 "type": "object" 853 }, 854 "GoogleServiceAccount": { 855 "description": "Google service account", 856 "id": "GoogleServiceAccount", 857 "properties": { 858 "accountEmail": { 859 "description": "Email address of the service account.", 860 "type": "string" 861 }, 862 "subjectId": { 863 "description": "Unique identifier for the service account.", 864 "type": "string" 865 } 866 }, 867 "type": "object" 868 }, 869 "HttpData": { 870 "description": "An HttpData resource specifies a list of objects on the web to 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 `\"TsvHttpData-1.0\"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** \u2014 The location of the object. * **Length** \u2014 The size of the object in bytes. * **MD5** \u2014 The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer.", 871 "id": "HttpData", 872 "properties": { 873 "listUrl": { 874 "description": "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.", 875 "type": "string" 876 } 877 }, 878 "type": "object" 879 }, 880 "ListAgentPoolsResponse": { 881 "description": "Response from ListAgentPools.", 882 "id": "ListAgentPoolsResponse", 883 "properties": { 884 "agentPools": { 885 "description": "A list of agent pools.", 886 "items": { 887 "$ref": "AgentPool" 888 }, 889 "type": "array" 890 }, 891 "nextPageToken": { 892 "description": "The list next page token.", 893 "type": "string" 894 } 895 }, 896 "type": "object" 897 }, 898 "ListOperationsResponse": { 899 "description": "The response message for Operations.ListOperations.", 900 "id": "ListOperationsResponse", 901 "properties": { 902 "nextPageToken": { 903 "description": "The standard List next-page token.", 904 "type": "string" 905 }, 906 "operations": { 907 "description": "A list of operations that matches the specified filter in the request.", 908 "items": { 909 "$ref": "Operation" 910 }, 911 "type": "array" 912 } 913 }, 914 "type": "object" 915 }, 916 "ListTransferJobsResponse": { 917 "description": "Response from ListTransferJobs.", 918 "id": "ListTransferJobsResponse", 919 "properties": { 920 "nextPageToken": { 921 "description": "The list next page token.", 922 "type": "string" 923 }, 924 "transferJobs": { 925 "description": "A list of transfer jobs.", 926 "items": { 927 "$ref": "TransferJob" 928 }, 929 "type": "array" 930 } 931 }, 932 "type": "object" 933 }, 934 "LoggingConfig": { 935 "description": "Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details.", 936 "id": "LoggingConfig", 937 "properties": { 938 "enableOnpremGcsTransferLogs": { 939 "description": "For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.", 940 "type": "boolean" 941 }, 942 "logActionStates": { 943 "description": "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 instead.", 944 "items": { 945 "enum": [ 946 "LOGGABLE_ACTION_STATE_UNSPECIFIED", 947 "SUCCEEDED", 948 "FAILED" 949 ], 950 "enumDescriptions": [ 951 "Default value. This value is unused.", 952 "`LoggableAction` completed successfully. `SUCCEEDED` actions are logged as INFO.", 953 "`LoggableAction` terminated in an error state. `FAILED` actions are logged as ERROR." 954 ], 955 "type": "string" 956 }, 957 "type": "array" 958 }, 959 "logActions": { 960 "description": "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.", 961 "items": { 962 "enum": [ 963 "LOGGABLE_ACTION_UNSPECIFIED", 964 "FIND", 965 "DELETE", 966 "COPY" 967 ], 968 "enumDescriptions": [ 969 "Default value. This value is unused.", 970 "Listing objects in a bucket.", 971 "Deleting objects at the source or the destination.", 972 "Copying objects to Google Cloud Storage." 973 ], 974 "type": "string" 975 }, 976 "type": "array" 977 } 978 }, 979 "type": "object" 980 }, 981 "MetadataOptions": { 982 "description": "Specifies the metadata options for running a transfer.", 983 "id": "MetadataOptions", 984 "properties": { 985 "gid": { 986 "description": "Specifies how each file's GID attribute should be handled by the transfer. If unspecified, the default behavior is the same as GID_SKIP when the source is a POSIX file system.", 987 "enum": [ 988 "GID_UNSPECIFIED", 989 "GID_SKIP", 990 "GID_NUMBER" 991 ], 992 "enumDescriptions": [ 993 "GID behavior is unspecified.", 994 "Skip GID during a transfer job.", 995 "Preserve GID during a transfer job." 996 ], 997 "type": "string" 998 }, 999 "mode": { 1000 "description": "Specifies how each file's mode attribute should be handled by the transfer. If unspecified, the default behavior is the same as MODE_SKIP when the source is a POSIX file system.", 1001 "enum": [ 1002 "MODE_UNSPECIFIED", 1003 "MODE_SKIP", 1004 "MODE_PRESERVE" 1005 ], 1006 "enumDescriptions": [ 1007 "Mode behavior is unspecified.", 1008 "Skip mode during a transfer job.", 1009 "Preserve mode during a transfer job." 1010 ], 1011 "type": "string" 1012 }, 1013 "symlink": { 1014 "description": "Specifies how symlinks should be handled by the transfer. If unspecified, the default behavior is the same as SYMLINK_SKIP when the source is a POSIX file system.", 1015 "enum": [ 1016 "SYMLINK_UNSPECIFIED", 1017 "SYMLINK_SKIP", 1018 "SYMLINK_PRESERVE" 1019 ], 1020 "enumDescriptions": [ 1021 "Symlink behavior is unspecified. The default behavior is to skip symlinks during a transfer job.", 1022 "Skip symlinks during a transfer job.", 1023 "Preserve symlinks during a transfer job." 1024 ], 1025 "type": "string" 1026 }, 1027 "uid": { 1028 "description": "Specifies how each file's UID attribute should be handled by the transfer. If unspecified, the default behavior is the same as UID_SKIP when the source is a POSIX file system.", 1029 "enum": [ 1030 "UID_UNSPECIFIED", 1031 "UID_SKIP", 1032 "UID_NUMBER" 1033 ], 1034 "enumDescriptions": [ 1035 "UID behavior is unspecified.", 1036 "Skip UID during a transfer job.", 1037 "Preserve UID during a transfer job." 1038 ], 1039 "type": "string" 1040 } 1041 }, 1042 "type": "object" 1043 }, 1044 "NotificationConfig": { 1045 "description": "Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`: * `\"eventType\"`: one of the EventType values * `\"payloadFormat\"`: one of the PayloadFormat values * `\"projectId\"`: the project_id of the `TransferOperation` * `\"transferJobName\"`: the transfer_job_name of the `TransferOperation` * `\"transferOperationName\"`: the name of the `TransferOperation` The `PubsubMessage.data` contains a TransferOperation resource formatted according to the specified `PayloadFormat`.", 1046 "id": "NotificationConfig", 1047 "properties": { 1048 "eventTypes": { 1049 "description": "Event types for which a notification is desired. If empty, send notifications for all event types.", 1050 "items": { 1051 "enum": [ 1052 "EVENT_TYPE_UNSPECIFIED", 1053 "TRANSFER_OPERATION_SUCCESS", 1054 "TRANSFER_OPERATION_FAILED", 1055 "TRANSFER_OPERATION_ABORTED" 1056 ], 1057 "enumDescriptions": [ 1058 "Illegal value, to avoid allowing a default.", 1059 "`TransferOperation` completed with status SUCCESS.", 1060 "`TransferOperation` completed with status FAILED.", 1061 "`TransferOperation` completed with status ABORTED." 1062 ], 1063 "type": "string" 1064 }, 1065 "type": "array" 1066 }, 1067 "payloadFormat": { 1068 "description": "Required. The desired format of the notification message payloads.", 1069 "enum": [ 1070 "PAYLOAD_FORMAT_UNSPECIFIED", 1071 "NONE", 1072 "JSON" 1073 ], 1074 "enumDescriptions": [ 1075 "Illegal value, to avoid allowing a default.", 1076 "No payload is included with the notification.", 1077 "`TransferOperation` is [formatted as a JSON response](https://developers.google.com/protocol-buffers/docs/proto3#json), in application/json." 1078 ], 1079 "type": "string" 1080 }, 1081 "pubsubTopic": { 1082 "description": "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 INVALID_ARGUMENT error.", 1083 "type": "string" 1084 } 1085 }, 1086 "type": "object" 1087 }, 1088 "ObjectConditions": { 1089 "description": "Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage. The \"last modification time\" refers to the time of the last change to the object's content or metadata \u2014 specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the `Last-Modified` header of Azure blobs. Transfers with a PosixFilesystem source or destination don't support `ObjectConditions`.", 1090 "id": "ObjectConditions", 1091 "properties": { 1092 "excludePrefixes": { 1093 "description": "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 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 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 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 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 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 included by `include_prefixes`. The max size of `exclude_prefixes` is 1000. For more information, see [Filtering objects from transfers](/storage-transfer/docs/filtering-objects-from-transfers).", 1094 "items": { 1095 "type": "string" 1096 }, 1097 "type": "array" 1098 }, 1099 "includePrefixes": { 1100 "description": "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 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 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 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 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 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 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).", 1101 "items": { 1102 "type": "string" 1103 }, 1104 "type": "array" 1105 }, 1106 "lastModifiedBefore": { 1107 "description": "If specified, only objects with a \"last modification time\" before this timestamp and objects that don't have a \"last modification time\" are transferred.", 1108 "format": "google-datetime", 1109 "type": "string" 1110 }, 1111 "lastModifiedSince": { 1112 "description": "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 `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 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", 1113 "format": "google-datetime", 1114 "type": "string" 1115 }, 1116 "maxTimeElapsedSinceLastModification": { 1117 "description": "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 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 max_time_elapsed_since_last_modification`. Objects that do not have a \"last modification time\" are also transferred.", 1118 "format": "google-duration", 1119 "type": "string" 1120 }, 1121 "minTimeElapsedSinceLastModification": { 1122 "description": "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 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 than the value of min_time_elapsed_since_last_modification`. Objects that do not have a \"last modification time\" are also transferred.", 1123 "format": "google-duration", 1124 "type": "string" 1125 } 1126 }, 1127 "type": "object" 1128 }, 1129 "Operation": { 1130 "description": "This resource represents a long-running operation that is the result of a network API call.", 1131 "id": "Operation", 1132 "properties": { 1133 "done": { 1134 "description": "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.", 1135 "type": "boolean" 1136 }, 1137 "error": { 1138 "$ref": "Status", 1139 "description": "The error result of the operation in case of failure or cancellation." 1140 }, 1141 "metadata": { 1142 "additionalProperties": { 1143 "description": "Properties of the object. Contains field @type with type URL.", 1144 "type": "any" 1145 }, 1146 "description": "Represents the transfer operation object. To request a TransferOperation object, use transferOperations.get.", 1147 "type": "object" 1148 }, 1149 "name": { 1150 "description": "The server-assigned unique name. The format of `name` is `transferOperations/some/unique/name`.", 1151 "type": "string" 1152 }, 1153 "response": { 1154 "additionalProperties": { 1155 "description": "Properties of the object. Contains field @type with type URL.", 1156 "type": "any" 1157 }, 1158 "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 `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", 1159 "type": "object" 1160 } 1161 }, 1162 "type": "object" 1163 }, 1164 "PauseTransferOperationRequest": { 1165 "description": "Request passed to PauseTransferOperation.", 1166 "id": "PauseTransferOperationRequest", 1167 "properties": {}, 1168 "type": "object" 1169 }, 1170 "PosixFilesystem": { 1171 "description": "A POSIX filesystem resource.", 1172 "id": "PosixFilesystem", 1173 "properties": { 1174 "rootDirectory": { 1175 "description": "Root directory path to the filesystem.", 1176 "type": "string" 1177 } 1178 }, 1179 "type": "object" 1180 }, 1181 "ResumeTransferOperationRequest": { 1182 "description": "Request passed to ResumeTransferOperation.", 1183 "id": "ResumeTransferOperationRequest", 1184 "properties": {}, 1185 "type": "object" 1186 }, 1187 "RunTransferJobRequest": { 1188 "description": "Request passed to RunTransferJob.", 1189 "id": "RunTransferJobRequest", 1190 "properties": { 1191 "projectId": { 1192 "description": "Required. The ID of the Google Cloud project that owns the transfer job.", 1193 "type": "string" 1194 } 1195 }, 1196 "type": "object" 1197 }, 1198 "Schedule": { 1199 "description": "Transfers can be scheduled to recur or to run just once.", 1200 "id": "Schedule", 1201 "properties": { 1202 "endTimeOfDay": { 1203 "$ref": "TimeOfDay", 1204 "description": "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 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 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 `schedule_end_date` is not set, then INVALID_ARGUMENT is returned." 1205 }, 1206 "repeatInterval": { 1207 "description": "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.", 1208 "format": "google-duration", 1209 "type": "string" 1210 }, 1211 "scheduleEndDate": { 1212 "$ref": "Date", 1213 "description": "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 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 `schedule_end_date` is in the future relative to UTC, the job runs each day at start_time_of_day through `schedule_end_date`." 1214 }, 1215 "scheduleStartDate": { 1216 "$ref": "Date", 1217 "description": "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 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 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 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 midnight UTC." 1218 }, 1219 "startTimeOfDay": { 1220 "$ref": "TimeOfDay", 1221 "description": "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. * 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. * Recurring transfers run at the specified time each day, through `schedule_end_date`." 1222 } 1223 }, 1224 "type": "object" 1225 }, 1226 "Status": { 1227 "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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", 1228 "id": "Status", 1229 "properties": { 1230 "code": { 1231 "description": "The status code, which should be an enum value of google.rpc.Code.", 1232 "format": "int32", 1233 "type": "integer" 1234 }, 1235 "details": { 1236 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", 1237 "items": { 1238 "additionalProperties": { 1239 "description": "Properties of the object. Contains field @type with type URL.", 1240 "type": "any" 1241 }, 1242 "type": "object" 1243 }, 1244 "type": "array" 1245 }, 1246 "message": { 1247 "description": "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 client.", 1248 "type": "string" 1249 } 1250 }, 1251 "type": "object" 1252 }, 1253 "TimeOfDay": { 1254 "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", 1255 "id": "TimeOfDay", 1256 "properties": { 1257 "hours": { 1258 "description": "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.", 1259 "format": "int32", 1260 "type": "integer" 1261 }, 1262 "minutes": { 1263 "description": "Minutes of hour of day. Must be from 0 to 59.", 1264 "format": "int32", 1265 "type": "integer" 1266 }, 1267 "nanos": { 1268 "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", 1269 "format": "int32", 1270 "type": "integer" 1271 }, 1272 "seconds": { 1273 "description": "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.", 1274 "format": "int32", 1275 "type": "integer" 1276 } 1277 }, 1278 "type": "object" 1279 }, 1280 "TransferCounters": { 1281 "description": "A collection of counters that report the progress of a transfer operation.", 1282 "id": "TransferCounters", 1283 "properties": { 1284 "bytesCopiedToSink": { 1285 "description": "Bytes that are copied to the data sink.", 1286 "format": "int64", 1287 "type": "string" 1288 }, 1289 "bytesDeletedFromSink": { 1290 "description": "Bytes that are deleted from the data sink.", 1291 "format": "int64", 1292 "type": "string" 1293 }, 1294 "bytesDeletedFromSource": { 1295 "description": "Bytes that are deleted from the data source.", 1296 "format": "int64", 1297 "type": "string" 1298 }, 1299 "bytesFailedToDeleteFromSink": { 1300 "description": "Bytes that failed to be deleted from the data sink.", 1301 "format": "int64", 1302 "type": "string" 1303 }, 1304 "bytesFoundFromSource": { 1305 "description": "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.", 1306 "format": "int64", 1307 "type": "string" 1308 }, 1309 "bytesFoundOnlyFromSink": { 1310 "description": "Bytes found only in the data sink that are scheduled to be deleted.", 1311 "format": "int64", 1312 "type": "string" 1313 }, 1314 "bytesFromSourceFailed": { 1315 "description": "Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred.", 1316 "format": "int64", 1317 "type": "string" 1318 }, 1319 "bytesFromSourceSkippedBySync": { 1320 "description": "Bytes in the data source that are not transferred because they already exist in the data sink.", 1321 "format": "int64", 1322 "type": "string" 1323 }, 1324 "directoriesFailedToListFromSource": { 1325 "description": "For transfers involving PosixFilesystem only. Number of listing failures for each directory found at the source. Potential failures when listing a directory include permission failure or block failure. If listing a directory fails, no files in the directory are transferred.", 1326 "format": "int64", 1327 "type": "string" 1328 }, 1329 "directoriesFoundFromSource": { 1330 "description": "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 directories, `a/` and `b/` under this directory, the count after listing `base/`, `base/a/` and `base/b/` is 3.", 1331 "format": "int64", 1332 "type": "string" 1333 }, 1334 "directoriesSuccessfullyListedFromSource": { 1335 "description": "For transfers involving PosixFilesystem only. Number of successful listings for each directory found at the source.", 1336 "format": "int64", 1337 "type": "string" 1338 }, 1339 "intermediateObjectsCleanedUp": { 1340 "description": "Number of successfully cleaned up intermediate objects.", 1341 "format": "int64", 1342 "type": "string" 1343 }, 1344 "intermediateObjectsFailedCleanedUp": { 1345 "description": "Number of intermediate objects failed cleaned up.", 1346 "format": "int64", 1347 "type": "string" 1348 }, 1349 "objectsCopiedToSink": { 1350 "description": "Objects that are copied to the data sink.", 1351 "format": "int64", 1352 "type": "string" 1353 }, 1354 "objectsDeletedFromSink": { 1355 "description": "Objects that are deleted from the data sink.", 1356 "format": "int64", 1357 "type": "string" 1358 }, 1359 "objectsDeletedFromSource": { 1360 "description": "Objects that are deleted from the data source.", 1361 "format": "int64", 1362 "type": "string" 1363 }, 1364 "objectsFailedToDeleteFromSink": { 1365 "description": "Objects that failed to be deleted from the data sink.", 1366 "format": "int64", 1367 "type": "string" 1368 }, 1369 "objectsFoundFromSource": { 1370 "description": "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.", 1371 "format": "int64", 1372 "type": "string" 1373 }, 1374 "objectsFoundOnlyFromSink": { 1375 "description": "Objects found only in the data sink that are scheduled to be deleted.", 1376 "format": "int64", 1377 "type": "string" 1378 }, 1379 "objectsFromSourceFailed": { 1380 "description": "Objects in the data source that failed to be transferred or that failed to be deleted after being transferred.", 1381 "format": "int64", 1382 "type": "string" 1383 }, 1384 "objectsFromSourceSkippedBySync": { 1385 "description": "Objects in the data source that are not transferred because they already exist in the data sink.", 1386 "format": "int64", 1387 "type": "string" 1388 } 1389 }, 1390 "type": "object" 1391 }, 1392 "TransferJob": { 1393 "description": "This resource represents the configuration of a transfer job that runs periodically.", 1394 "id": "TransferJob", 1395 "properties": { 1396 "creationTime": { 1397 "description": "Output only. The time that the transfer job was created.", 1398 "format": "google-datetime", 1399 "readOnly": true, 1400 "type": "string" 1401 }, 1402 "deletionTime": { 1403 "description": "Output only. The time that the transfer job was deleted.", 1404 "format": "google-datetime", 1405 "readOnly": true, 1406 "type": "string" 1407 }, 1408 "description": { 1409 "description": "A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.", 1410 "type": "string" 1411 }, 1412 "lastModificationTime": { 1413 "description": "Output only. The time that the transfer job was last modified.", 1414 "format": "google-datetime", 1415 "readOnly": true, 1416 "type": "string" 1417 }, 1418 "latestOperationName": { 1419 "description": "The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.", 1420 "type": "string" 1421 }, 1422 "loggingConfig": { 1423 "$ref": "LoggingConfig", 1424 "description": "Logging configuration." 1425 }, 1426 "name": { 1427 "description": "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. 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 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 with `transferJobs/OPI` specifically. For all other transfer types, this name must not start with `transferJobs/OPI`. Non-PosixFilesystem example: `\"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 naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error.", 1428 "type": "string" 1429 }, 1430 "notificationConfig": { 1431 "$ref": "NotificationConfig", 1432 "description": "Notification configuration. This is not supported for transfers involving PosixFilesystem." 1433 }, 1434 "projectId": { 1435 "description": "The ID of the Google Cloud project that owns the job.", 1436 "type": "string" 1437 }, 1438 "schedule": { 1439 "$ref": "Schedule", 1440 "description": "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 to have a non-empty schedule." 1441 }, 1442 "status": { 1443 "description": "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 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.", 1444 "enum": [ 1445 "STATUS_UNSPECIFIED", 1446 "ENABLED", 1447 "DISABLED", 1448 "DELETED" 1449 ], 1450 "enumDescriptions": [ 1451 "Zero is an illegal value.", 1452 "New transfers are performed based on the schedule.", 1453 "New transfers are not scheduled.", 1454 "This is a soft delete state. After a transfer job is set to this state, the job and all the transfer executions are subject to garbage collection. Transfer jobs become eligible for garbage collection 30 days after their status is set to `DELETED`." 1455 ], 1456 "type": "string" 1457 }, 1458 "transferSpec": { 1459 "$ref": "TransferSpec", 1460 "description": "Transfer specification." 1461 } 1462 }, 1463 "type": "object" 1464 }, 1465 "TransferManifest": { 1466 "description": "Specifies where the manifest is located.", 1467 "id": "TransferManifest", 1468 "properties": { 1469 "location": { 1470 "description": "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 is `gs://bucket_name/path/manifest.csv`.", 1471 "type": "string" 1472 } 1473 }, 1474 "type": "object" 1475 }, 1476 "TransferOperation": { 1477 "description": "A description of the execution of a transfer.", 1478 "id": "TransferOperation", 1479 "properties": { 1480 "counters": { 1481 "$ref": "TransferCounters", 1482 "description": "Information about the progress of the transfer operation." 1483 }, 1484 "endTime": { 1485 "description": "End time of this transfer execution.", 1486 "format": "google-datetime", 1487 "type": "string" 1488 }, 1489 "errorBreakdowns": { 1490 "description": "Summarizes errors encountered with sample error log entries.", 1491 "items": { 1492 "$ref": "ErrorSummary" 1493 }, 1494 "type": "array" 1495 }, 1496 "name": { 1497 "description": "A globally unique ID assigned by the system.", 1498 "type": "string" 1499 }, 1500 "notificationConfig": { 1501 "$ref": "NotificationConfig", 1502 "description": "Notification configuration." 1503 }, 1504 "projectId": { 1505 "description": "The ID of the Google Cloud project that owns the operation.", 1506 "type": "string" 1507 }, 1508 "startTime": { 1509 "description": "Start time of this transfer execution.", 1510 "format": "google-datetime", 1511 "type": "string" 1512 }, 1513 "status": { 1514 "description": "Status of the transfer operation.", 1515 "enum": [ 1516 "STATUS_UNSPECIFIED", 1517 "IN_PROGRESS", 1518 "PAUSED", 1519 "SUCCESS", 1520 "FAILED", 1521 "ABORTED", 1522 "QUEUED" 1523 ], 1524 "enumDescriptions": [ 1525 "Zero is an illegal value.", 1526 "In progress.", 1527 "Paused.", 1528 "Completed successfully.", 1529 "Terminated due to an unrecoverable failure.", 1530 "Aborted by the user.", 1531 "Temporarily delayed by the system. No user action is required." 1532 ], 1533 "type": "string" 1534 }, 1535 "transferJobName": { 1536 "description": "The name of the transfer job that triggers this transfer operation.", 1537 "type": "string" 1538 }, 1539 "transferSpec": { 1540 "$ref": "TransferSpec", 1541 "description": "Transfer specification." 1542 } 1543 }, 1544 "type": "object" 1545 }, 1546 "TransferOptions": { 1547 "description": "TransferOptions define the actions to be performed on objects in a transfer.", 1548 "id": "TransferOptions", 1549 "properties": { 1550 "deleteObjectsFromSourceAfterTransfer": { 1551 "description": "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.", 1552 "type": "boolean" 1553 }, 1554 "deleteObjectsUniqueInSink": { 1555 "description": "Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive.", 1556 "type": "boolean" 1557 }, 1558 "metadataOptions": { 1559 "$ref": "MetadataOptions", 1560 "description": "Represents the selected metadata options for a transfer job." 1561 }, 1562 "overwriteObjectsAlreadyExistingInSink": { 1563 "description": "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 name matches an object in the source are overwritten with the source object.", 1564 "type": "boolean" 1565 } 1566 }, 1567 "type": "object" 1568 }, 1569 "TransferSpec": { 1570 "description": "Configuration for running a transfer.", 1571 "id": "TransferSpec", 1572 "properties": { 1573 "awsS3DataSource": { 1574 "$ref": "AwsS3Data", 1575 "description": "An AWS S3 data source." 1576 }, 1577 "azureBlobStorageDataSource": { 1578 "$ref": "AzureBlobStorageData", 1579 "description": "An Azure Blob Storage data source." 1580 }, 1581 "gcsDataSink": { 1582 "$ref": "GcsData", 1583 "description": "A Cloud Storage data sink." 1584 }, 1585 "gcsDataSource": { 1586 "$ref": "GcsData", 1587 "description": "A Cloud Storage data source." 1588 }, 1589 "gcsIntermediateDataLocation": { 1590 "$ref": "GcsData", 1591 "description": "Cloud Storage intermediate data location." 1592 }, 1593 "httpDataSource": { 1594 "$ref": "HttpData", 1595 "description": "An HTTP URL data source." 1596 }, 1597 "objectConditions": { 1598 "$ref": "ObjectConditions", 1599 "description": "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 exclude objects in a data sink." 1600 }, 1601 "posixDataSink": { 1602 "$ref": "PosixFilesystem", 1603 "description": "A POSIX Filesystem data sink." 1604 }, 1605 "posixDataSource": { 1606 "$ref": "PosixFilesystem", 1607 "description": "A POSIX Filesystem data source." 1608 }, 1609 "sinkAgentPoolName": { 1610 "description": "Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.", 1611 "type": "string" 1612 }, 1613 "sourceAgentPoolName": { 1614 "description": "Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.", 1615 "type": "string" 1616 }, 1617 "transferManifest": { 1618 "$ref": "TransferManifest", 1619 "description": "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 used. ObjectConditions still apply." 1620 }, 1621 "transferOptions": { 1622 "$ref": "TransferOptions", 1623 "description": "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 error." 1624 } 1625 }, 1626 "type": "object" 1627 }, 1628 "UpdateTransferJobRequest": { 1629 "description": "Request passed to UpdateTransferJob.", 1630 "id": "UpdateTransferJobRequest", 1631 "properties": { 1632 "projectId": { 1633 "description": "Required. The ID of the Google Cloud project that owns the job.", 1634 "type": "string" 1635 }, 1636 "transferJob": { 1637 "$ref": "TransferJob", 1638 "description": "Required. The job to update. `transferJob` is expected to specify one or more of five fields: description, transfer_spec, notification_config, [logging_config[TransferJob.logging_config], and status. An `UpdateTransferJobRequest` that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires `storagetransfer.jobs.delete` permissions." 1639 }, 1640 "updateTransferJobFieldMask": { 1641 "description": "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, 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 any required fields is rejected with the error INVALID_ARGUMENT.", 1642 "format": "google-fieldmask", 1643 "type": "string" 1644 } 1645 }, 1646 "type": "object" 1647 } 1648 }, 1649 "servicePath": "", 1650 "title": "Storage Transfer API", 1651 "version": "v1", 1652 "version_module": true 1653}
