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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/storagetransfer__v1.json

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 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/tracing__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 e26c1a168da3ef3683d43cdbc26b0565d1b1ffba..9304addd18ee765791c28c57ce259ce819220794 100644
--- a/discovery/googleapis/storagetransfer__v1.json
+++ b/discovery/googleapis/storagetransfer__v1.json
@@ -24,6 +24,27 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
+ "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"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
@@ -35,13 +56,18 @@
"location": "query",
"type": "boolean"
},
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "callback": {
+ "description": "JSONP",
"location": "query",
"type": "string"
},
@@ -58,11 +84,6 @@
"location": "query",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -79,34 +100,13 @@
"location": "query",
"type": "string"
},
- "key": {
- "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.",
- "location": "query",
- "type": "string"
- },
"access_token": {
"description": "OAuth access token.",
"location": "query",
"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.",
- "location": "query",
- "type": "string"
- },
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
- "location": "query",
- "type": "boolean"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "key": {
+ "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.",
"location": "query",
"type": "string"
}
@@ -250,10 +250,10 @@
},
"transferOperations": {
"methods": {
- "pause": {
- "description": "Pauses a transfer operation.",
+ "resume": {
+ "description": "Resumes a transfer operation that is paused.",
"httpMethod": "POST",
- "id": "storagetransfer.transferOperations.pause",
+ "id": "storagetransfer.transferOperations.resume",
"parameterOrder": [
"name"
],
@@ -266,9 +266,9 @@
"type": "string"
}
},
- "path": "v1/{+name}:pause",
+ "path": "v1/{+name}:resume",
"request": {
- "$ref": "PauseTransferOperationRequest"
+ "$ref": "ResumeTransferOperationRequest"
},
"response": {
"$ref": "Empty"
@@ -277,23 +277,23 @@
"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",
+ "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.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
- "description": "The name of the operation resource to be deleted.",
+ "description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^transferOperations/.+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+name}",
+ "path": "v1/{+name}:cancel",
"response": {
"$ref": "Empty"
},
@@ -301,50 +301,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "list": {
- "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`.",
+ "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.list",
+ "id": "storagetransfer.transferOperations.get",
"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`.",
+ "description": "The name of the operation resource.",
"location": "path",
- "pattern": "^transferOperations$",
+ "pattern": "^transferOperations/.+$",
"required": true,
"type": "string"
- },
- "pageToken": {
- "description": "The list page token.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "The list page size. The max allowed value is 256.",
- "format": "int32",
- "location": "query",
- "type": "integer"
}
},
"path": "v1/{+name}",
"response": {
- "$ref": "ListOperationsResponse"
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "resume": {
- "description": "Resumes a transfer operation that is paused.",
+ "pause": {
+ "description": "Pauses a transfer operation.",
"httpMethod": "POST",
- "id": "storagetransfer.transferOperations.resume",
+ "id": "storagetransfer.transferOperations.pause",
"parameterOrder": [
"name"
],
@@ -357,9 +341,9 @@
"type": "string"
}
},
- "path": "v1/{+name}:resume",
+ "path": "v1/{+name}:pause",
"request": {
- "$ref": "ResumeTransferOperationRequest"
+ "$ref": "PauseTransferOperationRequest"
},
"response": {
"$ref": "Empty"
@@ -368,23 +352,23 @@
"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.",
- "httpMethod": "POST",
- "id": "storagetransfer.transferOperations.cancel",
+ "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 cancelled.",
+ "description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^transferOperations/.+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+name}:cancel",
+ "path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
@@ -392,25 +376,41 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "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.",
+ "list": {
+ "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 allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"httpMethod": "GET",
- "id": "storagetransfer.transferOperations.get",
+ "id": "storagetransfer.transferOperations.list",
"parameterOrder": [
"name"
],
"parameters": {
+ "pageSize": {
+ "description": "The list page size. The max allowed value is 256.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "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 name of the operation resource.",
+ "description": "The value `transferOperations`.",
"location": "path",
- "pattern": "^transferOperations/.+$",
+ "pattern": "^transferOperations$",
"required": true,
"type": "string"
+ },
+ "pageToken": {
+ "description": "The list page token.",
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/{+name}",
"response": {
- "$ref": "Operation"
+ "$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
@@ -419,256 +419,78 @@
}
}
},
- "revision": "20170518",
+ "revision": "20170605",
"rootUrl": "https://storagetransfer.googleapis.com/",
"schemas": {
- "TransferJob": {
- "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
- "id": "TransferJob",
+ "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": {
- "lastModificationTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
+ "accessKeyId": {
+ "description": "AWS access key ID.\nRequired.",
"type": "string"
},
- "projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
+ "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,\nwhich will be copied, excluded based on conditions, or skipped due to\nfailures.",
+ "format": "int64",
"type": "string"
},
- "description": {
- "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "bytesDeletedFromSource": {
+ "description": "Bytes that are deleted from the data source.",
+ "format": "int64",
"type": "string"
},
- "creationTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
+ "objectsFailedToDeleteFromSink": {
+ "description": "Objects that failed to be deleted from the data sink.",
+ "format": "int64",
"type": "string"
},
- "transferSpec": {
- "$ref": "TransferSpec",
- "description": "Transfer specification.\nRequired."
+ "objectsDeletedFromSink": {
+ "description": "Objects that are deleted from the data sink.",
+ "format": "int64",
+ "type": "string"
},
- "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."
- ],
+ "objectsFoundOnlyFromSink": {
+ "description": "Objects found only in the data sink that are scheduled to be deleted.",
+ "format": "int64",
"type": "string"
},
- "schedule": {
- "$ref": "Schedule",
- "description": "Schedule specification.\nRequired."
+ "bytesFromSourceSkippedBySync": {
+ "description": "Bytes in the data source that are not transferred because they already\nexist in the data sink.",
+ "format": "int64",
+ "type": "string"
},
- "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.",
+ "bytesDeletedFromSink": {
+ "description": "Bytes that are deleted from the data sink.",
+ "format": "int64",
"type": "string"
},
- "deletionTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "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. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired."
- },
- "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."
- },
- "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."
- }
- },
- "type": "object"
- },
- "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": {
- "year": {
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "format": "int32",
- "type": "integer"
- },
- "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": {
- "endTime": {
- "description": "End time of this transfer execution.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Start time of this transfer execution.",
- "format": "google-datetime",
- "type": "string"
- },
- "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": [
- "STATUS_UNSPECIFIED",
- "IN_PROGRESS",
- "PAUSED",
- "SUCCESS",
- "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": {
- "$ref": "TransferCounters",
- "description": "Information about the progress of the transfer operation."
- },
- "errorBreakdowns": {
- "description": "Summarizes errors encountered with sample error log entries.",
- "items": {
- "$ref": "ErrorSummary"
- },
- "type": "array"
- },
- "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"
- },
- "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"
- },
- "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": {
- "secretAccessKey": {
- "description": "AWS secret access key. This field is not returned in RPC responses.\nRequired.",
- "type": "string"
- },
- "accessKeyId": {
- "description": "AWS access key ID.\nRequired.",
- "type": "string"
- }
- },
- "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,\nwhich will be copied, excluded based on conditions, or skipped due to\nfailures.",
- "format": "int64",
- "type": "string"
- },
- "bytesDeletedFromSource": {
- "description": "Bytes that are deleted from the data source.",
- "format": "int64",
- "type": "string"
- },
- "objectsFailedToDeleteFromSink": {
- "description": "Objects that failed to be deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "objectsDeletedFromSink": {
- "description": "Objects that are deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "objectsFoundOnlyFromSink": {
- "description": "Objects found only in the data sink that are scheduled to be deleted.",
- "format": "int64",
- "type": "string"
- },
- "bytesFromSourceSkippedBySync": {
- "description": "Bytes in the data source that are not transferred because they already\nexist in the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesFailedToDeleteFromSink": {
- "description": "Bytes that failed to be deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesDeletedFromSink": {
- "description": "Bytes that are deleted from the data sink.",
- "format": "int64",
+ "bytesFailedToDeleteFromSink": {
+ "description": "Bytes that failed to be deleted from the data sink.",
+ "format": "int64",
"type": "string"
},
"bytesFromSourceFailed": {
@@ -676,13 +498,13 @@
"format": "int64",
"type": "string"
},
- "objectsCopiedToSink": {
- "description": "Objects that are copied to the data sink.",
+ "objectsFromSourceFailed": {
+ "description": "Objects in the data source that failed during the transfer.",
"format": "int64",
"type": "string"
},
- "objectsFromSourceFailed": {
- "description": "Objects in the data source that failed during the transfer.",
+ "objectsCopiedToSink": {
+ "description": "Objects that are copied to the data sink.",
"format": "int64",
"type": "string"
},
@@ -701,13 +523,13 @@
"format": "int64",
"type": "string"
},
- "objectsFromSourceSkippedBySync": {
- "description": "Objects in the data source that are not transferred because they already\nexist in the data sink.",
+ "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,\nwhich will be copied, excluded based on conditions, or skipped due to\nfailures.",
+ "objectsFromSourceSkippedBySync": {
+ "description": "Objects in the data source that are not transferred because they already\nexist in the data sink.",
"format": "int64",
"type": "string"
}
@@ -801,16 +623,16 @@
"description": "Response from ListTransferJobs.",
"id": "ListTransferJobsResponse",
"properties": {
- "nextPageToken": {
- "description": "The list next page token.",
- "type": "string"
- },
"transferJobs": {
"description": "A list of transfer jobs.",
"items": {
"$ref": "TransferJob"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "The list next page token.",
+ "type": "string"
}
},
"type": "object"
@@ -819,6 +641,10 @@
"description": "Request passed to UpdateTransferJob.",
"id": "UpdateTransferJobRequest",
"properties": {
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
+ "type": "string"
+ },
"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",
@@ -827,10 +653,6 @@
"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"
@@ -839,6 +661,11 @@
"description": "Conditions that determine which objects will be transferred.",
"id": "ObjectConditions",
"properties": {
+ "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": {
@@ -857,11 +684,6 @@
"type": "string"
},
"type": "array"
- },
- "maxTimeElapsedSinceLastModification": {
- "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
- "format": "google-duration",
- "type": "string"
}
},
"type": "object"
@@ -870,6 +692,18 @@
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
"properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "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"
@@ -885,37 +719,6 @@
"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."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Represents the transfer operation object.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "TransferOptions": {
- "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
- "id": "TransferOptions",
- "properties": {
- "deleteObjectsUniqueInSink": {
- "description": "Whether objects that exist only in the sink should be deleted.",
- "type": "boolean"
- },
- "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"
}
},
"type": "object"
@@ -924,14 +727,6 @@
"description": "Configuration for running a transfer.",
"id": "TransferSpec",
"properties": {
- "gcsDataSink": {
- "$ref": "GcsData",
- "description": "A Google Cloud Storage data sink."
- },
- "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."
@@ -947,24 +742,41 @@
"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."
+ },
+ "gcsDataSource": {
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data source."
}
},
"type": "object"
},
- "ResumeTransferOperationRequest": {
- "description": "Request passed to ResumeTransferOperation.",
- "id": "ResumeTransferOperationRequest",
- "properties": {},
+ "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"
},
"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` that 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.\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": {
- "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"
- },
"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": {
@@ -980,24 +792,34 @@
"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"
},
+ "ResumeTransferOperationRequest": {
+ "description": "Request passed to ResumeTransferOperation.",
+ "id": "ResumeTransferOperationRequest",
+ "properties": {},
+ "type": "object"
+ },
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
},
"type": "object"
@@ -1017,11 +839,6 @@
"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\nto allow the value \"24:00:00\" for scenarios like business closing time.",
- "format": "int32",
- "type": "integer"
- },
"nanos": {
"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"format": "int32",
@@ -1036,6 +853,11 @@
"description": "Minutes of hour of day. Must be from 0 to 59.",
"format": "int32",
"type": "integer"
+ },
+ "hours": {
+ "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"
}
},
"type": "object"
@@ -1057,6 +879,184 @@
}
},
"type": "object"
+ },
+ "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": "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"
+ },
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
+ "type": "string"
+ },
+ "lastModificationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "description": {
+ "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "type": "string"
+ },
+ "transferSpec": {
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
+ },
+ "creationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Schedule": {
+ "description": "Transfers can be scheduled to recur or to run just once.",
+ "id": "Schedule",
+ "properties": {
+ "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."
+ },
+ "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."
+ },
+ "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"
+ },
+ "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": {
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": {
+ "counters": {
+ "$ref": "TransferCounters",
+ "description": "Information about the progress of the transfer operation."
+ },
+ "status": {
+ "description": "Status of the transfer operation.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "IN_PROGRESS",
+ "PAUSED",
+ "SUCCESS",
+ "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"
+ },
+ "errorBreakdowns": {
+ "description": "Summarizes errors encountered with sample error log entries.",
+ "items": {
+ "$ref": "ErrorSummary"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "endTime": {
+ "description": "End time of this transfer execution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time of this transfer execution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transferJobName": {
+ "description": "The name of the transfer job that triggers this transfer operation.",
+ "type": "string"
+ },
+ "transferSpec": {
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
+ }
+ },
+ "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"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/storage__v1.json ('k') | discovery/googleapis/tracing__v2.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698