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

Unified Diff: discovery/googleapis/storagetransfer__v1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 5 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/speech__v1.json ('k') | discovery/googleapis/streetviewpublish__v1.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 690fa7ee5520d63d08062d0d5aeb6d85f6562f52..07b7634b58dae0d09f75890bb6ca069fbd94ff1c 100644
--- a/discovery/googleapis/storagetransfer__v1.json
+++ b/discovery/googleapis/storagetransfer__v1.json
@@ -24,40 +24,6 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "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",
@@ -109,63 +75,73 @@
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "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"
}
},
"protocol": "rest",
"resources": {
- "transferOperations": {
+ "googleServiceAccounts": {
"methods": {
"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.",
+ "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.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.pause",
+ "id": "storagetransfer.googleServiceAccounts.get",
"parameterOrder": [
- "name"
+ "projectId"
],
"parameters": {
- "name": {
- "description": "The name of the transfer operation.\nRequired.",
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired.",
"location": "path",
- "pattern": "^transferOperations/.+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+name}:pause",
- "request": {
- "$ref": "PauseTransferOperationRequest"
- },
+ "path": "v1/googleServiceAccounts/{projectId}",
"response": {
- "$ref": "Empty"
+ "$ref": "GoogleServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
- },
+ }
+ }
+ },
+ "transferOperations": {
+ "methods": {
"delete": {
"description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
"httpMethod": "DELETE",
@@ -280,17 +256,90 @@
"scopes": [
"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.",
+ "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.pause",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the transfer operation.\nRequired.",
+ "location": "path",
+ "pattern": "^transferOperations/.+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:pause",
+ "request": {
+ "$ref": "PauseTransferOperationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "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",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/transferJobs",
+ "request": {
+ "$ref": "TransferJob"
+ },
+ "response": {
+ "$ref": "TransferJob"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
"list": {
"description": "Lists transfer jobs.",
"httpMethod": "GET",
"id": "storagetransfer.transferJobs.list",
"parameterOrder": [],
"parameters": {
+ "pageToken": {
+ "description": "The list page token.",
+ "location": "query",
+ "type": "string"
+ },
"pageSize": {
"description": "The list page size. The max allowed value is 256.",
"format": "int32",
@@ -301,11 +350,6 @@
"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"
- },
- "pageToken": {
- "description": "The list page token.",
- "location": "query",
- "type": "string"
}
},
"path": "v1/transferJobs",
@@ -371,284 +415,47 @@
"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"
- ]
- }
- }
- },
- "googleServiceAccounts": {
- "methods": {
- "get": {
- "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": [
- "projectId"
- ],
- "parameters": {
- "projectId": {
- "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"
- }
- },
- "path": "v1/googleServiceAccounts/{projectId}",
- "response": {
- "$ref": "GoogleServiceAccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
}
}
}
},
- "revision": "20170705",
+ "revision": "20170720",
"rootUrl": "https://storagetransfer.googleapis.com/",
"schemas": {
- "ErrorLogEntry": {
- "description": "An entry describing an error that has occurred.",
- "id": "ErrorLogEntry",
+ "TransferCounters": {
+ "description": "A collection of counters that report the progress of a transfer operation.",
+ "id": "TransferCounters",
"properties": {
- "errorDetails": {
- "description": "A list of messages that carry the error details.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "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"
},
- "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"
- }
- },
- "type": "object"
- },
- "TransferJob": {
- "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
- "id": "TransferJob",
- "properties": {
- "description": {
- "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
- "type": "string"
- },
- "creationTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
- "type": "string"
- },
- "transferSpec": {
- "$ref": "TransferSpec",
- "description": "Transfer specification.\nRequired."
- },
- "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"
- }
- },
- "type": "object"
- },
- "Schedule": {
- "description": "Transfers can be scheduled to recur or to run just once.",
- "id": "Schedule",
- "properties": {
- "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."
- },
- "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."
- }
- },
- "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": {
- "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"
- },
- "year": {
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "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": {
- "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"
- },
- "endTime": {
- "description": "End time of this transfer execution.",
- "format": "google-datetime",
+ "bytesDeletedFromSource": {
+ "description": "Bytes that are deleted from the data source.",
+ "format": "int64",
"type": "string"
},
- "startTime": {
- "description": "Start time of this transfer execution.",
- "format": "google-datetime",
+ "objectsFailedToDeleteFromSink": {
+ "description": "Objects that failed to be deleted from the data sink.",
+ "format": "int64",
"type": "string"
},
- "transferJobName": {
- "description": "The name of the transfer job that triggers this transfer operation.",
+ "objectsFoundOnlyFromSink": {
+ "description": "Objects found only in the data sink that are scheduled to be deleted.",
+ "format": "int64",
"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.",
+ "objectsDeletedFromSink": {
+ "description": "Objects that are deleted from the data sink.",
+ "format": "int64",
"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.",
+ "bytesFromSourceSkippedBySync": {
+ "description": "Bytes in the data source that are not transferred because they already\nexist in the data sink.",
+ "format": "int64",
"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": {
"bytesFailedToDeleteFromSink": {
"description": "Bytes that failed to be deleted from the data sink.",
"format": "int64",
@@ -664,13 +471,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"
},
@@ -698,36 +505,6 @@
"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"
- },
- "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"
}
},
"type": "object"
@@ -819,16 +596,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"
@@ -837,6 +614,10 @@
"description": "Request passed to UpdateTransferJob.",
"id": "UpdateTransferJobRequest",
"properties": {
+ "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"
@@ -845,10 +626,6 @@
"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."
}
},
"type": "object"
@@ -857,6 +634,13 @@
"description": "Conditions that determine which objects will be transferred.",
"id": "ObjectConditions",
"properties": {
+ "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"
+ },
+ "type": "array"
+ },
"excludePrefixes": {
"description": "`excludePrefixes` must follow the requirements described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 1000.",
"items": {
@@ -873,13 +657,6 @@
"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"
- },
- "type": "array"
}
},
"type": "object"
@@ -888,10 +665,6 @@
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
"properties": {
- "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.",
@@ -915,6 +688,10 @@
},
"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"
}
},
"type": "object"
@@ -923,10 +700,6 @@
"description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
"id": "TransferOptions",
"properties": {
- "deleteObjectsFromSourceAfterTransfer": {
- "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive.",
- "type": "boolean"
- },
"deleteObjectsUniqueInSink": {
"description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTransfer` are mutually\nexclusive.",
"type": "boolean"
@@ -934,6 +707,10 @@
"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. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive.",
+ "type": "boolean"
}
},
"type": "object"
@@ -969,21 +746,18 @@
},
"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": {
- "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"
- },
+ "ResumeTransferOperationRequest": {
+ "description": "Request passed to ResumeTransferOperation.",
+ "id": "ResumeTransferOperationRequest",
+ "properties": {},
+ "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": {
"details": {
- "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -992,30 +766,33 @@
"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"
},
- "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"
@@ -1035,6 +812,11 @@
"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": {
+ "minutes": {
+ "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",
@@ -1049,14 +831,232 @@
"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"
+ }
+ },
+ "type": "object"
+ },
+ "ErrorLogEntry": {
+ "description": "An entry describing an error that has occurred.",
+ "id": "ErrorLogEntry",
+ "properties": {
+ "errorDetails": {
+ "description": "A list of messages that carry the error details.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "minutes": {
- "description": "Minutes of hour of day. Must be from 0 to 59.",
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "TransferJob": {
+ "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
+ "id": "TransferJob",
+ "properties": {
+ "creationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transferSpec": {
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
+ },
+ "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"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "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": {
+ "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."
+ },
+ "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."
+ }
+ },
+ "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"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/speech__v1.json ('k') | discovery/googleapis/streetviewpublish__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698