Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2293)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/storagetransfer__v1.json

Issue 2824163002: Api-roll 48: 2017-04-18 (Closed)
Patch Set: Revert changes to pubspecs Created 3 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/storage__v1.json ('k') | discovery/googleapis/surveys__v2.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/storagetransfer__v1.json
diff --git a/discovery/googleapis/storagetransfer__v1.json b/discovery/googleapis/storagetransfer__v1.json
index 7c039084850d41c9ccf43ab9e0112ea567b5f4e0..a65aab2d980fe285a617d1426369a5130f581f3c 100644
--- a/discovery/googleapis/storagetransfer__v1.json
+++ b/discovery/googleapis/storagetransfer__v1.json
@@ -14,7 +14,6 @@
"description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/storage/transfer",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/fmXUMBI6Gn2x3crK-Doz-fh96kI\"",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -25,24 +24,26 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "access_token": {
- "description": "OAuth access token.",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"type": "string"
},
@@ -51,8 +52,24 @@
"location": "query",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
"location": "query",
"type": "string"
},
@@ -61,8 +78,8 @@
"location": "query",
"type": "string"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "quotaUser": {
+ "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.",
"location": "query",
"type": "string"
},
@@ -72,14 +89,13 @@
"location": "query",
"type": "boolean"
},
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"location": "query",
- "type": "boolean"
+ "type": "string"
},
- "quotaUser": {
- "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.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
},
@@ -88,19 +104,11 @@
"location": "query",
"type": "string"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
"location": "query",
- "type": "string"
+ "type": "boolean"
}
},
"protocol": "rest",
@@ -108,7 +116,7 @@
"googleServiceAccounts": {
"methods": {
"get": {
- "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 Developers Console 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.",
+ "description": "Returns the Google service account that is used by Storage Transfer\nService to access buckets in the project where transfers\nrun or in other projects. Each Google service account is associated\nwith one Google Cloud Platform Console project. Users\nshould add this service account to the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Service. This service\naccount is created and owned by Storage Transfer Service and can\nonly be used by Storage Transfer Service.",
"httpMethod": "GET",
"id": "storagetransfer.googleServiceAccounts.get",
"parameterOrder": [
@@ -116,7 +124,7 @@
],
"parameters": {
"projectId": {
- "description": "The ID of the Google Developers Console project that the Google service account is associated with. Required.",
+ "description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired.",
"location": "path",
"required": true,
"type": "string"
@@ -132,48 +140,10 @@
}
}
},
- "v1": {
- "methods": {
- "getGoogleServiceAccount": {
- "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 Developers Console 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.",
- "httpMethod": "GET",
- "id": "storagetransfer.getGoogleServiceAccount",
- "parameters": {
- "projectId": {
- "description": "The ID of the Google Developers Console project that the Google service account is associated with. Required.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1:getGoogleServiceAccount",
- "response": {
- "$ref": "GoogleServiceAccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
"transferJobs": {
"methods": {
- "create": {
- "description": "Creates a transfer job that runs periodically.",
- "httpMethod": "POST",
- "id": "storagetransfer.transferJobs.create",
- "path": "v1/transferJobs",
- "request": {
- "$ref": "TransferJob"
- },
- "response": {
- "$ref": "TransferJob"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
"patch": {
- "description": "Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed.",
+ "description": "Updates a transfer job. Updating a job's transfer spec does not affect\ntransfer operations that are running already. Updating the scheduling\nof a job is not allowed.",
"httpMethod": "PATCH",
"id": "storagetransfer.transferJobs.patch",
"parameterOrder": [
@@ -181,9 +151,9 @@
],
"parameters": {
"jobName": {
- "description": "The name of job to update. Required.",
+ "description": "The name of job to update.\nRequired.",
"location": "path",
- "pattern": "^transferJobs/.*$",
+ "pattern": "^transferJobs/.+$",
"required": true,
"type": "string"
}
@@ -208,14 +178,14 @@
],
"parameters": {
"jobName": {
- "description": "The job to get. Required.",
+ "description": "The job to get.\nRequired.",
"location": "path",
- "pattern": "^transferJobs/.*$",
+ "pattern": "^transferJobs/.+$",
"required": true,
"type": "string"
},
"projectId": {
- "description": "The ID of the Google Developers Console project that owns the job. Required.",
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
"location": "query",
"type": "string"
}
@@ -232,9 +202,10 @@
"description": "Lists transfer jobs.",
"httpMethod": "GET",
"id": "storagetransfer.transferJobs.list",
+ "parameterOrder": [],
"parameters": {
- "filter": {
- "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 must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.",
+ "pageToken": {
+ "description": "The list page token.",
"location": "query",
"type": "string"
},
@@ -244,8 +215,8 @@
"location": "query",
"type": "integer"
},
- "pageToken": {
- "description": "The list page token.",
+ "filter": {
+ "description": "A list of query parameters specified as JSON text in the form of\n{\"project_id\":\"my_project_id\",\n\"job_names\":[\"jobid1\",\"jobid2\",...],\n\"job_statuses\":[\"status1\",\"status2\",...]}.\nSince `job_names` and `job_statuses` support multiple values, their values\nmust be specified with array notation. `project_id` is required. `job_names`\nand `job_statuses` are optional. The valid values for `job_statuses` are\ncase-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.",
"location": "query",
"type": "string"
}
@@ -257,31 +228,45 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "create": {
+ "description": "Creates a transfer job that runs periodically.",
+ "httpMethod": "POST",
+ "id": "storagetransfer.transferJobs.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/transferJobs",
+ "request": {
+ "$ref": "TransferJob"
+ },
+ "response": {
+ "$ref": "TransferJob"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
},
"transferOperations": {
"methods": {
- "pause": {
- "description": "Pauses a transfer operation.",
+ "cancel": {
+ "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
"httpMethod": "POST",
- "id": "storagetransfer.transferOperations.pause",
+ "id": "storagetransfer.transferOperations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
- "description": "The name of the transfer operation. Required.",
+ "description": "The name of the operation resource to be cancelled.",
"location": "path",
- "pattern": "^transferOperations/.*$",
+ "pattern": "^transferOperations/.+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+name}:pause",
- "request": {
- "$ref": "PauseTransferOperationRequest"
- },
+ "path": "v1/{+name}:cancel",
"response": {
"$ref": "Empty"
},
@@ -289,25 +274,49 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "resume": {
- "description": "Resumes a transfer operation that is paused.",
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "id": "storagetransfer.transferOperations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "location": "path",
+ "pattern": "^transferOperations/.+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "pause": {
+ "description": "Pauses a transfer operation.",
"httpMethod": "POST",
- "id": "storagetransfer.transferOperations.resume",
+ "id": "storagetransfer.transferOperations.pause",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
- "description": "The name of the transfer operation. Required.",
+ "description": "The name of the transfer operation.\nRequired.",
"location": "path",
- "pattern": "^transferOperations/.*$",
+ "pattern": "^transferOperations/.+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+name}:resume",
+ "path": "v1/{+name}:pause",
"request": {
- "$ref": "ResumeTransferOperationRequest"
+ "$ref": "PauseTransferOperationRequest"
},
"response": {
"$ref": "Empty"
@@ -316,38 +325,43 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "get": {
- "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.",
- "httpMethod": "GET",
- "id": "storagetransfer.transferOperations.get",
+ "delete": {
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
+ "httpMethod": "DELETE",
+ "id": "storagetransfer.transferOperations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
- "description": "The name of the operation resource.",
+ "description": "The name of the operation resource to be deleted.",
"location": "path",
- "pattern": "^transferOperations/.*$",
+ "pattern": "^transferOperations/.+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
- "$ref": "Operation"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
"httpMethod": "GET",
"id": "storagetransfer.transferOperations.list",
"parameterOrder": [
"name"
],
"parameters": {
+ "filter": {
+ "description": "A list of query parameters specified as JSON text in the form of {\\\"project_id\\\" : \\\"my_project_id\\\", \\\"job_names\\\" : [\\\"jobid1\\\", \\\"jobid2\\\",...], \\\"operation_names\\\" : [\\\"opid1\\\", \\\"opid2\\\",...], \\\"transfer_statuses\\\":[\\\"status1\\\", \\\"status2\\\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.",
+ "location": "query",
+ "type": "string"
+ },
"name": {
"description": "The value `transferOperations`.",
"location": "path",
@@ -355,21 +369,16 @@
"required": true,
"type": "string"
},
- "filter": {
- "description": "The standard list filter.",
+ "pageToken": {
+ "description": "The list page token.",
"location": "query",
"type": "string"
},
"pageSize": {
- "description": "The standard list page size.",
+ "description": "The list page size. The max allowed value is 256.",
"format": "int32",
"location": "query",
"type": "integer"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "location": "query",
- "type": "string"
}
},
"path": "v1/{+name}",
@@ -380,47 +389,26 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "cancel": {
- "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
+ "resume": {
+ "description": "Resumes a transfer operation that is paused.",
"httpMethod": "POST",
- "id": "storagetransfer.transferOperations.cancel",
+ "id": "storagetransfer.transferOperations.resume",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
- "description": "The name of the operation resource to be cancelled.",
+ "description": "The name of the transfer operation.\nRequired.",
"location": "path",
- "pattern": "^transferOperations/.*$",
+ "pattern": "^transferOperations/.+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+name}:cancel",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
- "httpMethod": "DELETE",
- "id": "storagetransfer.transferOperations.delete",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "location": "path",
- "pattern": "^transferOperations/.*$",
- "required": true,
- "type": "string"
- }
+ "path": "v1/{+name}:resume",
+ "request": {
+ "$ref": "ResumeTransferOperationRequest"
},
- "path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
@@ -431,424 +419,237 @@
}
}
},
- "revision": "20150811",
+ "revision": "20170327",
"rootUrl": "https://storagetransfer.googleapis.com/",
"schemas": {
- "GoogleServiceAccount": {
- "description": "Google service account",
- "id": "GoogleServiceAccount",
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
"properties": {
- "accountEmail": {
- "description": "Required.",
+ "details": {
+ "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
- "TransferJob": {
- "description": "This resource represents the configuration of a transfer job that runs periodically.",
- "id": "TransferJob",
+ "ResumeTransferOperationRequest": {
+ "description": "Request passed to ResumeTransferOperation.",
+ "id": "ResumeTransferOperationRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
"properties": {
- "name": {
- "description": "A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error.",
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
"type": "string"
},
- "description": {
- "description": "A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.",
- "type": "string"
- },
- "projectId": {
- "description": "The ID of the Google Developers Console project that owns the job. Required.",
- "type": "string"
- },
- "transferSpec": {
- "$ref": "TransferSpec",
- "description": "Transfer specification. Required."
- },
- "schedule": {
- "$ref": "Schedule",
- "description": "Schedule specification. Required."
- },
- "status": {
- "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.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DELETED"
- ],
- "type": "string"
- },
- "creationTime": {
- "description": "This field cannot be changed by user requests.",
- "type": "string"
- },
- "lastModificationTime": {
- "description": "This field cannot be changed by user requests.",
- "type": "string"
- },
- "deletionTime": {
- "description": "This field cannot be changed by user requests.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "TransferSpec": {
- "description": "Configuration for running a transfer.",
- "id": "TransferSpec",
- "properties": {
- "gcsDataSource": {
- "$ref": "GcsData",
- "description": "A Google Cloud Storage data source."
- },
- "awsS3DataSource": {
- "$ref": "AwsS3Data",
- "description": "An AWS S3 data source."
- },
- "httpDataSource": {
- "$ref": "HttpData",
- "description": "An HTTP URL data source."
- },
- "gcsDataSink": {
- "$ref": "GcsData",
- "description": "A Google Cloud Storage data sink."
- },
- "objectConditions": {
- "$ref": "ObjectConditions",
- "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' `lastModificationTime` do not exclude objects in a data sink."
- },
- "transferOptions": {
- "$ref": "TransferOptions",
- "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."
- }
- },
- "type": "object"
- },
- "GcsData": {
- "description": "In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated.",
- "id": "GcsData",
- "properties": {
- "bucketName": {
- "description": "Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AwsS3Data": {
- "description": "An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name.",
- "id": "AwsS3Data",
- "properties": {
- "bucketName": {
- "description": "S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required.",
- "type": "string"
- },
- "awsAccessKey": {
- "$ref": "AwsAccessKey",
- "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 ID of the AWS access key. Required."
- }
- },
- "type": "object"
- },
- "AwsAccessKey": {
- "description": "AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
- "id": "AwsAccessKey",
- "properties": {
- "accessKeyId": {
- "description": "AWS access key ID. Required.",
- "type": "string"
- },
- "secretAccessKey": {
- "description": "AWS secret access key. This field is not returned in RPC responses. Required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "HttpData": {
- "description": "An HttpData 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 * Length * MD5 - This field is 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 not match the MD5 computed from the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in HttpData objects. The objects that the URL list points to must allow public access. Storage Transfer Service obeys `robots.txt` rules and requires the HTTP server to support Range requests and to return a Content-Length header in each response.",
- "id": "HttpData",
- "properties": {
- "listUrl": {
- "description": "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. Required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ObjectConditions": {
- "description": "Conditions that determine which objects will be transferred.",
- "id": "ObjectConditions",
- "properties": {
- "minTimeElapsedSinceLastModification": {
- "description": "If unspecified, `minTimeElapsedSinceLastModification` 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` - `maxTimeElapsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModification`, or not have a `lastModificationTime`.",
- "type": "string"
- },
- "maxTimeElapsedSinceLastModification": {
- "description": "`maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.",
- "type": "string"
- },
- "includePrefixes": {
- "description": "If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 20.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "excludePrefixes": {
- "description": "`excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 20.",
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
- "type": "string"
+ "$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
- "TransferOptions": {
- "description": "TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer.",
- "id": "TransferOptions",
- "properties": {
- "overwriteObjectsAlreadyExistingInSink": {
- "description": "Whether overwriting objects that already exist in the sink is allowed.",
- "type": "boolean"
- },
- "deleteObjectsUniqueInSink": {
- "description": "Whether objects that exist only in the sink should be deleted.",
- "type": "boolean"
- },
- "deleteObjectsFromSourceAfterTransfer": {
- "description": "Whether objects should be deleted from the source after they are transferred to the sink.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "Schedule": {
- "description": "Transfers can be scheduled to recur or to run just once.",
- "id": "Schedule",
- "properties": {
- "scheduleStartDate": {
- "$ref": "Date",
- "description": "The first day the recurring transfer is scheduled to run. Required."
- },
- "scheduleEndDate": {
- "$ref": "Date",
- "description": "The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once."
- },
- "startTimeOfDay": {
- "$ref": "TimeOfDay",
- "description": "The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, transfers are scheduled to start at midnight UTC."
- }
- },
- "type": "object"
- },
- "Date": {
- "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 significant. 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 card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.",
- "id": "Date",
+ "GoogleServiceAccount": {
+ "description": "Google service account",
+ "id": "GoogleServiceAccount",
"properties": {
- "year": {
- "description": "Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.",
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "description": "Month of year of date. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
- },
- "day": {
- "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 sigificant.",
- "format": "int32",
- "type": "integer"
+ "accountEmail": {
+ "description": "Required.",
+ "type": "string"
}
},
"type": "object"
},
"TimeOfDay": {
- "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 leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`.",
+ "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
"id": "TimeOfDay",
"properties": {
"hours": {
- "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.",
+ "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
- "minutes": {
- "description": "Minutes of hour of day. Must be from 0 to 59.",
+ "nanos": {
+ "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"format": "int32",
"type": "integer"
},
"seconds": {
- "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.",
+ "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
},
- "nanos": {
- "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
+ "minutes": {
+ "description": "Minutes of hour of day. Must be from 0 to 59.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "UpdateTransferJobRequest": {
- "description": "Request passed to UpdateTransferJob.",
- "id": "UpdateTransferJobRequest",
+ "ErrorLogEntry": {
+ "description": "An entry describing an error that has occurred.",
+ "id": "ErrorLogEntry",
"properties": {
- "projectId": {
- "description": "The ID of the Google Developers Console project that owns the job. Required.",
+ "url": {
+ "description": "A URL that refers to the target (a data source, a data sink,\nor an object) with which the error is associated.\nRequired.",
"type": "string"
},
- "transferJob": {
- "$ref": "TransferJob",
- "description": "The job to update. Required."
- },
- "updateTransferJobFieldMask": {
- "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`, `transferSpec`, and `status`. To update the `transferSpec` of the job, a complete transfer specification has to be provided. An incomplete specification which misses any required fields will be rejected with the error `INVALID_ARGUMENT`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListTransferJobsResponse": {
- "description": "Response from ListTransferJobs.",
- "id": "ListTransferJobsResponse",
- "properties": {
- "transferJobs": {
- "description": "A list of transfer jobs.",
+ "errorDetails": {
+ "description": "A list of messages that carry the error details.",
"items": {
- "$ref": "TransferJob"
+ "type": "string"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "The list next page token.",
- "type": "string"
}
},
"type": "object"
},
- "PauseTransferOperationRequest": {
- "description": "Request passed to PauseTransferOperation.",
- "id": "PauseTransferOperationRequest",
- "type": "object"
- },
- "Empty": {
- "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 `{}`.",
- "id": "Empty",
- "type": "object"
- },
- "ResumeTransferOperationRequest": {
- "description": "Request passed to ResumeTransferOperation.",
- "id": "ResumeTransferOperationRequest",
- "type": "object"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "id": "Operation",
+ "TransferJob": {
+ "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
+ "id": "TransferJob",
"properties": {
+ "status": {
+ "description": "Status of the job. This value MUST be specified for\n`CreateTransferJobRequests`.\n\nNOTE: The effect of the new job status takes place during a subsequent job\nrun. For example, if you change the job status from `ENABLED` to\n`DISABLED`, and an operation spawned by the transfer is running, the status\nchange would not affect the current operation.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DELETED"
+ ],
+ "enumDescriptions": [
+ "Zero is an illegal value.",
+ "New transfers will be performed based on the schedule.",
+ "New transfers will not be scheduled.",
+ "This is a soft delete state. After a transfer job is set to this\nstate, the job and all the transfer executions are subject to\ngarbage collection."
+ ],
+ "type": "string"
+ },
+ "schedule": {
+ "$ref": "Schedule",
+ "description": "Schedule specification.\nRequired."
+ },
+ "deletionTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.",
+ "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror.",
"type": "string"
},
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @ype with type URL.",
- "type": "any"
- },
- "description": "Represents the transfer operation object.",
- "type": "object"
+ "lastModificationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
},
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress. If true, the operation is completed and the `result` is available.",
- "type": "boolean"
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
+ "type": "string"
},
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure."
+ "description": {
+ "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "type": "string"
},
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @ype with type URL.",
- "type": "any"
- },
- "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`.",
- "type": "object"
+ "transferSpec": {
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
+ },
+ "creationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"type": "object"
},
- "Status": {
- "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 designed 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 or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the 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 exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, 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 environments. Example uses of this error model include: - Partial errors. If a service 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 typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should 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.",
- "id": "Status",
+ "Schedule": {
+ "description": "Transfers can be scheduled to recur or to run just once.",
+ "id": "Schedule",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
- "format": "int32",
- "type": "integer"
+ "scheduleEndDate": {
+ "$ref": "Date",
+ "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce."
},
- "message": {
- "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][google.rpc.Status.details] field, or localized by the client.",
- "type": "string"
+ "startTimeOfDay": {
+ "$ref": "TimeOfDay",
+ "description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone."
},
- "details": {
- "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @ype with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
+ "scheduleStartDate": {
+ "$ref": "Date",
+ "description": "The first day the recurring transfer is scheduled to run. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired."
}
},
"type": "object"
},
- "ListOperationsResponse": {
- "description": "The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].",
- "id": "ListOperationsResponse",
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "id": "Date",
"properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32",
+ "type": "integer"
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "day": {
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "TransferOperation": {
- "description": "A description of the execution of a transfer.",
- "id": "TransferOperation",
- "properties": {
- "name": {
- "description": "A globally unique ID assigned by the system.",
- "type": "string"
- },
- "projectId": {
- "description": "The ID of the Google Developers Console project that owns the operation. Required.",
+ "TransferOperation": {
+ "description": "A description of the execution of a transfer.",
+ "id": "TransferOperation",
+ "properties": {
+ "endTime": {
+ "description": "End time of this transfer execution.",
+ "format": "google-datetime",
"type": "string"
},
- "transferSpec": {
- "$ref": "TransferSpec",
- "description": "Transfer specification. Required."
- },
"startTime": {
"description": "Start time of this transfer execution.",
+ "format": "google-datetime",
"type": "string"
},
- "endTime": {
- "description": "End time of this transfer execution.",
+ "transferJobName": {
+ "description": "The name of the transfer job that triggers this transfer operation.",
"type": "string"
},
+ "transferSpec": {
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
+ },
"status": {
"description": "Status of the transfer operation.",
"enum": [
@@ -859,6 +660,14 @@
"FAILED",
"ABORTED"
],
+ "enumDescriptions": [
+ "Zero is an illegal value.",
+ "In progress.",
+ "Paused.",
+ "Completed successfully.",
+ "Terminated due to an unrecoverable failure.",
+ "Aborted by the user."
+ ],
"type": "string"
},
"counters": {
@@ -872,74 +681,120 @@
},
"type": "array"
},
- "transferJobName": {
- "description": "The name of the transfer job that triggers this transfer operation.",
+ "name": {
+ "description": "A globally unique ID assigned by the system.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AwsS3Data": {
+ "description": "An AwsS3Data can be a data source, but not a data sink.\nIn an AwsS3Data, an object's name is the S3 object's key name.",
+ "id": "AwsS3Data",
+ "properties": {
+ "bucketName": {
+ "description": "S3 Bucket name (see\n[Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).\nRequired.",
+ "type": "string"
+ },
+ "awsAccessKey": {
+ "$ref": "AwsAccessKey",
+ "description": "AWS access key used to sign the API requests to the AWS S3 bucket.\nPermissions on the bucket must be granted to the access ID of the\nAWS access key.\nRequired."
+ }
+ },
+ "type": "object"
+ },
+ "AwsAccessKey": {
+ "description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
+ "id": "AwsAccessKey",
+ "properties": {
+ "accessKeyId": {
+ "description": "AWS access key ID.\nRequired.",
+ "type": "string"
+ },
+ "secretAccessKey": {
+ "description": "AWS secret access key. This field is not returned in RPC responses.\nRequired.",
"type": "string"
}
},
"type": "object"
},
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "PauseTransferOperationRequest": {
+ "description": "Request passed to PauseTransferOperation.",
+ "id": "PauseTransferOperationRequest",
+ "properties": {},
+ "type": "object"
+ },
"TransferCounters": {
"description": "A collection of counters that report the progress of a transfer operation.",
"id": "TransferCounters",
"properties": {
- "objectsFoundFromSource": {
- "description": "Objects found in the data source that are scheduled to be transferred, which will be copied, excluded based on conditions, or skipped due to failures.",
+ "bytesFoundFromSource": {
+ "description": "Bytes found in the data source that are scheduled to be transferred,\nwhich will be copied, excluded based on conditions, or skipped due to\nfailures.",
"format": "int64",
"type": "string"
},
- "bytesFoundFromSource": {
- "description": "Bytes found in the data source that are scheduled to be transferred, which will be copied, excluded based on conditions, or skipped due to failures.",
+ "objectsFromSourceSkippedBySync": {
+ "description": "Objects in the data source that are not transferred because they already\nexist in the data sink.",
"format": "int64",
"type": "string"
},
- "objectsFoundOnlyFromSink": {
- "description": "Objects found only in the data sink that are scheduled to be deleted.",
+ "bytesDeletedFromSource": {
+ "description": "Bytes that are deleted from the data source.",
"format": "int64",
"type": "string"
},
- "bytesFoundOnlyFromSink": {
- "description": "Bytes found only in the data sink that are scheduled to be deleted.",
+ "objectsFoundFromSource": {
+ "description": "Objects found in the data source that are scheduled to be transferred,\nwhich will be copied, excluded based on conditions, or skipped due to\nfailures.",
"format": "int64",
"type": "string"
},
- "objectsFromSourceSkippedBySync": {
- "description": "Objects in the data source that are not transferred because they already exist in the data sink.",
+ "objectsFailedToDeleteFromSink": {
+ "description": "Objects that failed to be deleted from the data sink.",
"format": "int64",
"type": "string"
},
- "bytesFromSourceSkippedBySync": {
- "description": "Bytes in the data source that are not transferred because they already exist in the data sink.",
+ "objectsFoundOnlyFromSink": {
+ "description": "Objects found only in the data sink that are scheduled to be deleted.",
"format": "int64",
"type": "string"
},
- "objectsCopiedToSink": {
- "description": "Objects that are copied to the data sink.",
+ "objectsDeletedFromSink": {
+ "description": "Objects that are deleted from the data sink.",
"format": "int64",
"type": "string"
},
- "bytesCopiedToSink": {
- "description": "Bytes that are copied to the data sink.",
+ "bytesFromSourceSkippedBySync": {
+ "description": "Bytes in the data source that are not transferred because they already\nexist in the data sink.",
"format": "int64",
"type": "string"
},
- "objectsDeletedFromSource": {
- "description": "Objects that are deleted from the data source.",
+ "bytesDeletedFromSink": {
+ "description": "Bytes that are deleted from the data sink.",
"format": "int64",
"type": "string"
},
- "bytesDeletedFromSource": {
- "description": "Bytes that are deleted from the data source.",
+ "bytesFailedToDeleteFromSink": {
+ "description": "Bytes that failed to be deleted from the data sink.",
"format": "int64",
"type": "string"
},
- "objectsDeletedFromSink": {
- "description": "Objects that are deleted from the data sink.",
+ "bytesFromSourceFailed": {
+ "description": "Bytes in the data source that failed during the transfer.",
"format": "int64",
"type": "string"
},
- "bytesDeletedFromSink": {
- "description": "Bytes that are deleted from the data sink.",
+ "objectsCopiedToSink": {
+ "description": "Objects that are copied to the data sink.",
"format": "int64",
"type": "string"
},
@@ -948,18 +803,18 @@
"format": "int64",
"type": "string"
},
- "bytesFromSourceFailed": {
- "description": "Bytes in the data source that failed during the transfer.",
+ "bytesFoundOnlyFromSink": {
+ "description": "Bytes found only in the data sink that are scheduled to be deleted.",
"format": "int64",
"type": "string"
},
- "objectsFailedToDeleteFromSink": {
- "description": "Objects that failed to be deleted from the data sink.",
+ "objectsDeletedFromSource": {
+ "description": "Objects that are deleted from the data source.",
"format": "int64",
"type": "string"
},
- "bytesFailedToDeleteFromSink": {
- "description": "Bytes that failed to be deleted from the data sink.",
+ "bytesCopiedToSink": {
+ "description": "Bytes that are copied to the data sink.",
"format": "int64",
"type": "string"
}
@@ -967,7 +822,7 @@
"type": "object"
},
"ErrorSummary": {
- "description": "A summary of errors by error code, plus a count and sample error log entries.",
+ "description": "A summary of errors by error code, plus a count and sample error log\nentries.",
"id": "ErrorSummary",
"properties": {
"errorCode": {
@@ -991,10 +846,29 @@
"UNAVAILABLE",
"DATA_LOSS"
],
+ "enumDescriptions": [
+ "Not an error; returned on success\n\nHTTP Mapping: 200 OK",
+ "The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request",
+ "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error",
+ "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request",
+ "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout",
+ "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found",
+ "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict",
+ "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden",
+ "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized",
+ "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests",
+ "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request",
+ "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict",
+ "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request",
+ "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented",
+ "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error",
+ "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable",
+ "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error"
+ ],
"type": "string"
},
"errorCount": {
- "description": "Count of this type of error. Required.",
+ "description": "Count of this type of error.\nRequired.",
"format": "int64",
"type": "string"
},
@@ -1008,16 +882,89 @@
},
"type": "object"
},
- "ErrorLogEntry": {
- "description": "An entry describing an error that has occurred.",
- "id": "ErrorLogEntry",
+ "HttpData": {
+ "description": "An HttpData specifies a list of objects on the web to be transferred over\nHTTP. The information of the objects to be transferred is contained in a\nfile referenced by a URL. The first line in the file must be\n\"TsvHttpData-1.0\", which specifies the format of the file. Subsequent lines\nspecify the information of the list of objects, one object per list entry.\nEach entry has the following tab-delimited fields:\n\n* HTTP URL - The location of the object.\n\n* Length - The size of the object in bytes.\n\n* MD5 - The base64-encoded MD5 hash of the object.\n\nFor an example of a valid TSV file, see\n[Transferring data from URLs](https://cloud.google.com/storage/transfer/#urls)\n\nWhen transferring data based on a URL list, keep the following in mind:\n\n* When an object located at `http(s)://hostname:port/<URL-path>` is transferred\nto a data sink, the name of the object at the data sink is\n`<hostname>/<URL-path>`.\n\n* If the specified size of an object does not match the actual size of the\nobject fetched, the object will not be transferred.\n\n* If the specified MD5 does not match the MD5 computed from the transferred\nbytes, the object transfer will fail. For more information, see\n[Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5)\n\n* Ensure that each URL you specify is publicly accessible. For\nexample, in Google Cloud Storage you can\n[share an object publicly]\n(https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get\na link to it.\n\n* Storage Transfer Service obeys `robots.txt` rules and requires the source\nHTTP server to support `Range` requests and to return a `Content-Length`\nheader in each response.\n\n* [ObjectConditions](#ObjectConditions) have no effect when filtering objects\nto transfer.",
+ "id": "HttpData",
"properties": {
- "url": {
- "description": "A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. Required.",
+ "listUrl": {
+ "description": "The URL that points to the file that stores the object list entries.\nThis file must allow public access. Currently, only URLs with HTTP and\nHTTPS schemes are supported.\nRequired.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GcsData": {
+ "description": "In a GcsData, an object's name is the Google Cloud Storage object's name and\nits `lastModificationTime` refers to the object's updated time, which changes\nwhen the content or the metadata of the object is updated.",
+ "id": "GcsData",
+ "properties": {
+ "bucketName": {
+ "description": "Google Cloud Storage bucket name (see\n[Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nRequired.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListTransferJobsResponse": {
+ "description": "Response from ListTransferJobs.",
+ "id": "ListTransferJobsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The list next page token.",
"type": "string"
},
- "errorDetails": {
- "description": "A list of messages that carry the error details.",
+ "transferJobs": {
+ "description": "A list of transfer jobs.",
+ "items": {
+ "$ref": "TransferJob"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateTransferJobRequest": {
+ "description": "Request passed to UpdateTransferJob.",
+ "id": "UpdateTransferJobRequest",
+ "properties": {
+ "updateTransferJobFieldMask": {
+ "description": "The field mask of the fields in `transferJob` that are to be updated in\nthis request. Fields in `transferJob` that can be updated are:\n`description`, `transferSpec`, and `status`. To update the `transferSpec`\nof the job, a complete transfer specification has to be provided. An\nincomplete specification which misses any required fields will be rejected\nwith the error `INVALID_ARGUMENT`.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "transferJob": {
+ "$ref": "TransferJob",
+ "description": "The job to update.\nRequired."
+ },
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ObjectConditions": {
+ "description": "Conditions that determine which objects will be transferred.",
+ "id": "ObjectConditions",
+ "properties": {
+ "minTimeElapsedSinceLastModification": {
+ "description": "If unspecified, `minTimeElapsedSinceLastModification` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes the maximum possible\nvalue of Duration. Objects that satisfy the object conditions\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTimeElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastModification`, or not have a\n`lastModificationTime`.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "excludePrefixes": {
+ "description": "`excludePrefixes` must follow the requirements described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 1000.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "maxTimeElapsedSinceLastModification": {
+ "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "includePrefixes": {
+ "description": "If `includePrefixes` is specified, objects that satisfy the object\nconditions must have names that start with one of the `includePrefixes`\nand that do not start with any of the `excludePrefixes`. If `includePrefixes`\nis not specified, all objects except those that have names starting with\none of the `excludePrefixes` must satisfy the object conditions.\n\nRequirements:\n\n * Each include-prefix and exclude-prefix can contain any sequence of\n Unicode characters, of max length 1024 bytes when UTF8-encoded, and\n must not contain Carriage Return or Line Feed characters. Wildcard\n matching and regular expression matching are not supported.\n\n * Each include-prefix and exclude-prefix must omit the leading slash.\n For example, to include the `requests.gz` object in a transfer from\n `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include\n prefix as `logs/y=2015/requests.gz`.\n\n * None of the include-prefix or the exclude-prefix values can be empty,\n if specified.\n\n * Each include-prefix must include a distinct portion of the object\n namespace, i.e., no include-prefix may be a prefix of another\n include-prefix.\n\n * Each exclude-prefix must exclude a distinct portion of the object\n namespace, i.e., no exclude-prefix may be a prefix of another\n exclude-prefix.\n\n * If `includePrefixes` is specified, then each exclude-prefix must start\n with the value of a path explicitly included by `includePrefixes`.\n\nThe max size of `includePrefixes` is 1000.",
"items": {
"type": "string"
},
@@ -1025,6 +972,91 @@
}
},
"type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "id": "Operation",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Represents the transfer operation object.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ }
+ },
+ "type": "object"
+ },
+ "TransferSpec": {
+ "description": "Configuration for running a transfer.",
+ "id": "TransferSpec",
+ "properties": {
+ "gcsDataSource": {
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data source."
+ },
+ "transferOptions": {
+ "$ref": "TransferOptions",
+ "description": "If the option `deleteObjectsUniqueInSink` is `true`, object conditions\nbased on objects' `lastModificationTime` are ignored and do not exclude\nobjects in a data source or a data sink."
+ },
+ "awsS3DataSource": {
+ "$ref": "AwsS3Data",
+ "description": "An AWS S3 data source."
+ },
+ "httpDataSource": {
+ "$ref": "HttpData",
+ "description": "An HTTP URL data source."
+ },
+ "objectConditions": {
+ "$ref": "ObjectConditions",
+ "description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink."
+ },
+ "gcsDataSink": {
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data sink."
+ }
+ },
+ "type": "object"
+ },
+ "TransferOptions": {
+ "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
+ "id": "TransferOptions",
+ "properties": {
+ "overwriteObjectsAlreadyExistingInSink": {
+ "description": "Whether overwriting objects that already exist in the sink is allowed.",
+ "type": "boolean"
+ },
+ "deleteObjectsFromSourceAfterTransfer": {
+ "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink.",
+ "type": "boolean"
+ },
+ "deleteObjectsUniqueInSink": {
+ "description": "Whether objects that exist only in the sink should be deleted.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/storage__v1.json ('k') | discovery/googleapis/surveys__v2.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698